usePagedResource()

Home > @gooddata/sdk-ui > usePagedResource

usePagedResource() function

Hook for getting data from paged resource

Signature:

export declare function usePagedResource<TParams, TItem>(resourceFactory: (params: TParams) => Promise<IPagedResource<TItem>>, fetchParams: TParams[], fetchDeps: React.DependencyList, resetDeps: React.DependencyList, getCacheKey?: (params: TParams) => string, initialState?: IUsePagedResourceState<TItem>): IUsePagedResourceResult<TItem>;

Parameters

ParameterTypeDescription
resourceFactory(params: TParams) => Promise<IPagedResource<TItem>>
fetchParamsTParams[]
fetchDepsReact.DependencyList
resetDepsReact.DependencyList
getCacheKey(params: TParams) => string(Optional)
initialStateIUsePagedResourceState<TItem>(Optional)

Returns:

IUsePagedResourceResult<TItem>

← UseInsightDataViewCallbacksusePlaceholder() →