Skip to main content

Interface: SearchOptions

Search options for request.

Hierarchy​

Properties​

limit​

• Optional limit: number

Limit the number of items returned in the response.

Defined in​

types/lib.ts:77

after​

• Optional after: string

Return only items that occur after this marker. Before marker can be found from the response, inside the 'paging' property. Note that only after or before can be specified for a request, not both.

Defined in​

types/lib.ts:84

before​

• Optional before: string

Return only items that occur before this marker. Before marker can be found from the response, inside the 'paging' property. Note that only after or before can be specified for a request, not both.

Defined in​

types/lib.ts:91

cache​

• Optional cache: boolean

Whether to cache this response.

Inherited from​

OverrideOptions.cache

Defined in​

types/lib.ts:97

force​

• Optional force: boolean

Whether to skip the cache check and request the API.

Inherited from​

OverrideOptions.force

Defined in​

types/lib.ts:100

retryLimit​

• Optional retryLimit: number

How many times to retry on 5XX errors.

Inherited from​

OverrideOptions.retryLimit

Defined in​

types/lib.ts:103

ignoreRateLimit​

• Optional ignoreRateLimit: boolean

Whether to ignore throttlers.

Inherited from​

OverrideOptions.ignoreRateLimit

Defined in​

types/lib.ts:106

restRequestTimeout​

• Optional restRequestTimeout: number

Time to wait before cancelling a REST request, in milliseconds.

Inherited from​

OverrideOptions.restRequestTimeout

Defined in​

types/lib.ts:109