Type Alias PagedFetchConfig<TItem>

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;
}

Type Parameters

  • TItem

Type declaration

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

    Items per page. Defaults to 100.

  • OptionalonStart?: (() => void)

    Optional: called once before the first fetch starts

      • (): void

      • Returns void

  • OptionalonEnd?: ((result: InfinityFetchResult<TItem>) => void)

    Optional: called once after all pages have been fetched

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

    Called after each page is fetched

      • (items, response, pageIndex): void

      • Parameters

        Returns void

  • OptionalmaxPages?: number

    Maximum number of pages to fetch (safety limit)

  • Optionaldelay?: number

    Optional: milliseconds to wait between each page fetch

  • Optionalretry?: InfinityFetchRetryConfig

    Optional: retry failed page fetches

Settings

Member Visibility