Interface Options<T>

interface Options<T extends Entry = Entry> {
    beforeRequest?: (request: PagedRequest<T>) => Promise<void>;
    fromDate?: string | Date;
    maxResults?: number;
    onError?: (err: Error | ScrollError) => void;
    onProgress?: (items: T[], current: number, total?: number) => void;
    onScrollError?: (err: ScrollError) => void;
    signal?: AbortSignal;
    toDate?: string | Date;
}

Type Parameters

Hierarchy (View Summary)

Properties

beforeRequest? fromDate? maxResults? onError? onProgress? onScrollError? signal? toDate?

Properties

OptionalbeforeRequest

beforeRequest?: (request: PagedRequest<T>) => Promise<void>

OptionalfromDate

fromDate?: string | Date

OptionalmaxResults

maxResults?: number

maximum number of search results

OptionalonError

onError?: (err: Error | ScrollError) => void

Search results use a scrollID cursor that expires after 1-5 minutes from first request. If the scrollID expires then onScrollExpired will be called with a ScrollError. Default behavior is to throw the error.

Note that request level errors (like 401 or 500) will just be thrown as normal, not passed to this function

OptionalonProgress

onProgress?: (items: T[], current: number, total?: number) => void

callback per page

OptionalonScrollError

onScrollError?: (err: ScrollError) => void

Use onError instead

Deprecated

use onError instead

Optionalsignal

signal?: AbortSignal

OptionaltoDate

toDate?: string | Date

Settings

Member Visibility

On This Page

Properties