infinity-fetch - v1.4.0
    Preparing search index...

    Type Alias PagedFetchConfig<TItem>

    type PagedFetchConfig<TItem> = {
        fetcher: (params: PagedParams) => Promise<PagedResponse<TItem>>;
        limit?: number;
        onStart?: () => void;
        onEnd?: (result: InfinityFetchResult<TItem>) => void;
        onPage?: (
            items: TItem[],
            response: PagedResponse<TItem>,
            pageIndex: number,
        ) => void;
        maxPages?: number;
        delay?: number;
        retry?: InfinityFetchRetryConfig;
        signal?: AbortSignal;
    }

    Type Parameters

    • TItem
    Index

    Properties

    fetcher limit? onStart? onEnd? onPage? maxPages? delay? retry? signal?

    Properties

    fetcher: (params: PagedParams) => Promise<PagedResponse<TItem>>
    limit?: number

    Items per page. Defaults to 100.

    onStart?: () => void

    Optional: called once before the first fetch starts

    onEnd?: (result: InfinityFetchResult<TItem>) => void

    Optional: called once after all pages have been fetched

    onPage?: (
        items: TItem[],
        response: PagedResponse<TItem>,
        pageIndex: number,
    ) => void

    Called after each page is fetched

    maxPages?: number

    Maximum number of pages to fetch (safety limit)

    delay?: number

    Optional: milliseconds to wait between each page fetch

    retry?: InfinityFetchRetryConfig

    Optional: retry failed page fetches

    signal?: AbortSignal

    Optional: signal to abort pagination early and return partial results

    Settings

    Member Visibility

    On This Page

    Properties