Interface: ListOptions

Properties

optional page?: number

optional perPage?: number

optional search?: string

optional sortBy?: string

optional sortDir?: "asc" | "desc"

optional modifyQuery?: QueryModifier

Scope the base query before search/sort/pagination (e.g. the active tab).

optional trashed?: "with" | "only"

Soft-delete scope: include trashed (with) or only trashed (only).

optional thenSort?: readonly object[]

Tie-breakers applied after the primary sort, in order. "By status, then newest first" is two entries rather than a bespoke query.