Skip to content

OrderByParse

OrderByParse = { errors: []; items: OrderByItem[]; ok: true; } | { errors: FilterError[]; items: OrderByItem[]; ok: false; }

Defined in: packages/schema/src/filter/order-by.ts:7

What parseOrderBy gives: the order’s items, or the errors.

{ errors: []; items: OrderByItem[]; ok: true; }

errors: []

None.

items: OrderByItem[]

The fields to sort on, in order.

ok: true

The text parsed.


{ errors: FilterError[]; items: OrderByItem[]; ok: false; }

errors: FilterError[]

Each problem, with where it is in the text.

items: OrderByItem[]

The items that parsed.

ok: false

The text did not parse.