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

    Type Alias InfinityFetchConfig<TResponse, TParams, TItem, TOut>

    InfinityFetchConfig: PaginationOptions<TResponse, TItem, TOut> & {
        fetcher: (params: TParams, context: FetchContext) => Promise<TResponse>;
        initialParams: TParams;
        isLastPage: (response: TResponse) => boolean;
        getNextParams: (response: TResponse, currentParams: TParams) => TParams;
        getItems: (response: TResponse) => TItem[] | Promise<TItem[]>;
    }

    Type Parameters

    • TResponse
    • TParams extends object
    • TItem
    • TOut = TItem

    Type Declaration

    • fetcher: (params: TParams, context: FetchContext) => Promise<TResponse>

      The function that fetches a single page

    • initialParams: TParams

      Initial parameters for the first request

    • isLastPage: (response: TResponse) => boolean

      Returns true when no more pages should be fetched

    • getNextParams: (response: TResponse, currentParams: TParams) => TParams

      Returns the params for the next page request

    • getItems: (response: TResponse) => TItem[] | Promise<TItem[]>

      Extracts items from a single page response. May be async