@oneplatform/app-sdk

@oneplatform/app-sdk / QueryOptions

Interface: QueryOptions¶

Defined in: types/entities.ts:38

Properties¶

cursor?¶

optional cursor?: string

Defined in: types/entities.ts:45

Pagination cursor. Omit for the first page.

enabled?¶

optional enabled?: boolean

Defined in: types/entities.ts:49

When false, skip the fetch entirely. Default true.

fields?¶

optional fields?: string[]

Defined in: types/entities.ts:43

Field projection. Omit for all fields.

filter?¶

optional filter?: FilterSpec

Defined in: types/entities.ts:39

limit?¶

optional limit?: number

Defined in: types/entities.ts:47

Default 50, max 100

onError?¶

optional onError?: (error) => void

Defined in: types/entities.ts:52

Parameters¶

error¶

AppSDKError

Returns¶

void

sort?¶

optional sort?: string[]

Defined in: types/entities.ts:41

Prefix with "-" for descending order, e.g. ["-createdAt", "name"]

staleTime?¶

optional staleTime?: number

Defined in: types/entities.ts:51

Milliseconds before a cache entry is considered stale. Default 30_000.