Interface: PaginateOptions
Defined in: api/rust-fetch.d.ts:209
Options of client.paginate(): the request options of each page, and these.
Extends
Properties
allowAbsoluteUrls?
optionalallowAbsoluteUrls?:boolean
Defined in: api/rust-fetch.d.ts:430
Overrides the client's allowAbsoluteUrls
Inherited from
RequestOptions.allowAbsoluteUrls
allowInsecureRedirects?
optionalallowInsecureRedirects?:boolean
Defined in: api/rust-fetch.d.ts:436
Overrides the client's allowInsecureRedirects
Inherited from
RequestOptions.allowInsecureRedirects
allowPrivateNetwork?
optionalallowPrivateNetwork?:boolean
Defined in: api/rust-fetch.d.ts:440
Overrides the client's allowPrivateNetwork
Inherited from
RequestOptions.allowPrivateNetwork
cache?
optionalcache?:"default"|"no-store"|"reload"|"no-cache"|"force-cache"|"only-if-cached"
Defined in: api/rust-fetch.d.ts:74
How the browser's HTTP cache is used
Inherited from
connectTimeoutMs?
optionalconnectTimeoutMs?:number
Defined in: api/rust-fetch.d.ts:406
Time until a connection is established, including TLS (Node.js); browsers cannot observe it. 0 disables.
Inherited from
RequestOptions.connectTimeoutMs
credentials?
optionalcredentials?:"omit"|"same-origin"|"include"
Defined in: api/rust-fetch.d.ts:70
Send cookies and HTTP authentication: same-origin (default), include (also cross-origin) or omit
Inherited from
crossOrigin?
optionalcrossOrigin?:boolean
Defined in: api/rust-fetch.d.ts:217
Follow a next URL on another origin. Default false: it throws an InvalidInputError, so credentials never follow a server's redirect to another host.
deadlineMs?
optionaldeadlineMs?:number
Defined in: api/rust-fetch.d.ts:412
Total logical-request deadline, including queueing, retries and reading the body. 0 disables.
Inherited from
dedupe?
optionaldedupe?:boolean
Defined in: api/rust-fetch.d.ts:398
get and head only: share one request and response with identical requests in flight at once (same URL, headers and options), or false to opt out when the client's dedupe is on. Each caller gets its own response object. Not with streamed responseTypes.
Inherited from
headers?
optionalheaders?:HeadersLike
Defined in: api/rust-fetch.d.ts:401
Inherited from
httpCache?
optionalhttpCache?:boolean
Defined in: api/rust-fetch.d.ts:396
false skips the client's httpCache for this request: nothing is served from it or stored in it.
Inherited from
idempotencyHeader?
optionalidempotencyHeader?:string
Defined in: api/rust-fetch.d.ts:423
Overrides the client's idempotency header name
Inherited from
RequestOptions.idempotencyHeader
idempotencyKey?
optionalidempotencyKey?:string|boolean
Defined in: api/rust-fetch.d.ts:421
Overrides the client's key policy. true generates a key for this call; false disables it. Requires server deduplication.
Inherited from
idleTimeoutMs?
optionalidleTimeoutMs?:number
Defined in: api/rust-fetch.d.ts:410
Maximum wait for the next body chunk, including streams and SSE. 0 disables.
Inherited from
integrity?
optionalintegrity?:string
Defined in: api/rust-fetch.d.ts:83
Subresource integrity metadata, e.g. sha384-…
Inherited from
items?
optionalitems?: (response) =>Iterable<any,any,any> |Promise<Iterable<any,any,any>>
Defined in: api/rust-fetch.d.ts:211
The items of a page (an array, or a promise of one). Without it, paginate() yields the pages.
Parameters
response
Returns
Iterable<any, any, any> | Promise<Iterable<any, any, any>>
keepalive?
optionalkeepalive?:boolean
Defined in: api/rust-fetch.d.ts:76
Let the request outlive the page, e.g. for analytics on unload (bodies up to 64 KB)
Inherited from
maxLineBytes?
optionalmaxLineBytes?:number|null
Defined in: api/rust-fetch.d.ts:438
responseType: 'ndjson': overrides the client's maxLineBytes; null removes the limit for this request
Inherited from
maxPages?
optionalmaxPages?:number
Defined in: api/rust-fetch.d.ts:215
Stop after this many pages. Default 1000.
maxRedirects?
optionalmaxRedirects?:number
Defined in: api/rust-fetch.d.ts:428
Overrides the client's maxRedirects
Inherited from
maxResponseBytes?
optionalmaxResponseBytes?:number|null
Defined in: api/rust-fetch.d.ts:432
Overrides the client's maxResponseBytes; null removes the limit for this request
Inherited from
RequestOptions.maxResponseBytes
mode?
optionalmode?:"same-origin"|"cors"|"no-cors"
Defined in: api/rust-fetch.d.ts:72
cors (default), same-origin, or no-cors, which resolves with an opaque response (status: 0, no headers, no body)
Inherited from
next?
optionalnext?: (response) =>string|false| {params?:QueryParams;url?:string; } |Promise<string|false| {params?:QueryParams;url?:string; } |null|undefined> |null|undefined
Defined in: api/rust-fetch.d.ts:213
Where the next page is: a URL (relative ones resolve against the page's URL), or { url?, params? } (params are merged into the request's), or nothing for the last page. Default: the Link header's rel="next".
Parameters
response
Returns
string | false | { params?: QueryParams; url?: string; } | Promise<string | false | { params?: QueryParams; url?: string; } | null | undefined> | null | undefined
onDownloadProgress?
optionalonDownloadProgress?: (progress) =>void
Defined in: api/rust-fetch.d.ts:447
Called after each received chunk of a successful response
Parameters
progress
Returns
void
Inherited from
RequestOptions.onDownloadProgress
onUploadProgress?
optionalonUploadProgress?: (progress) =>void
Defined in: api/rust-fetch.d.ts:453
Called as the request body is sent; starts again from 0 if the request is retried. Browsers send these requests with XMLHttpRequest (cross-origin ones are preflighted). Can't be combined with responseType: 'stream'.
Parameters
progress
Returns
void
Inherited from
RequestOptions.onUploadProgress
params?
optionalparams?:QueryParams
Defined in: api/rust-fetch.d.ts:402
Inherited from
priority?
optionalpriority?:"high"|"low"|"auto"
Defined in: api/rust-fetch.d.ts:78
Fetch priority, where the browser supports it
Inherited from
redirect?
optionalredirect?:RedirectMode
Defined in: api/rust-fetch.d.ts:426
Overrides the client's redirect
Inherited from
referrer?
optionalreferrer?:string
Defined in: api/rust-fetch.d.ts:80
A same-origin URL, '' for none, or about:client (default)
Inherited from
referrerPolicy?
optionalreferrerPolicy?:""|"origin"|"same-origin"|"no-referrer"|"no-referrer-when-downgrade"|"strict-origin"|"origin-when-cross-origin"|"strict-origin-when-cross-origin"|"unsafe-url"
Defined in: api/rust-fetch.d.ts:81
Inherited from
responseTimeoutMs?
optionalresponseTimeoutMs?:number
Defined in: api/rust-fetch.d.ts:408
Time until final response headers arrive. 0 disables.
Inherited from
RequestOptions.responseTimeoutMs
responseType?
optionalresponseType?:ResponseBodyType
Defined in: api/rust-fetch.d.ts:424
Inherited from
resume?
optionalresume?:boolean| {maxResumes?:number; }
Defined in: api/rust-fetch.d.ts:394
get with responseType: 'stream' only: when the connection breaks mid-body, continue with a Range request (checked with If-Range) instead of failing, up to maxResumes times (default 3). Needs a server that sends Accept-Ranges: bytes, an ETag or Last-Modified, and no Content-Encoding; otherwise the stream fails as usual. response.resumes counts the continuations.
Inherited from
retries?
optionalretries?:number|RetryOptions
Defined in: api/rust-fetch.d.ts:419
Replaces the client's retry policy for this request (also for events() connection attempts). 0 disables retries. Omitted object fields use the standard defaults, not the client's values. The client's shared retryBudget still applies. Separate from events()'s reconnect.
Inherited from
schema?
optionalschema?:StandardSchema<unknown>
Defined in: api/rust-fetch.d.ts:400
Validate the response body with a Standard Schema (Zod, Valibot, ArkType…). The body of the response becomes the schema's output; a body that fails rejects with a ValidationError (not retried). Not with responseType: 'stream' or 'ndjson'.
Inherited from
sensitiveHeaders?
optionalsensitiveHeaders?:string[]
Defined in: api/rust-fetch.d.ts:434
Overrides the client's sensitiveHeaders
Inherited from
RequestOptions.sensitiveHeaders
signal?
optionalsignal?:AbortSignal
Defined in: api/rust-fetch.d.ts:445
Cancels the request (including pending retries) when aborted; rejects with a CancelledError. For responseType: 'stream' it also errors the body stream.
Inherited from
timeoutMs?
optionaltimeoutMs?:number
Defined in: api/rust-fetch.d.ts:404
Overrides the client timeout for this request, in ms. 0 disables it.