Function useApiPaginator

Parameters

• path: string

  The API endpoint path.
• Optionaloptions: IApiPaginatorParams<FilterData, RowData>

  The options object.

  Represents the parameters required for pagination in an API request.

  • OptionalabortSignal?: AbortSignal

  • OptionalchipsHandler?: (url: URL, chips: Partial<Record<keyof RowData, boolean>>) => URL

  • Optionalfallback?: (e: Error) => void

  • Optionalfetch?: (input: URL | RequestInfo, init?: RequestInit) => Promise<Response> & (
        input: URL | RequestInfo,
        init?: RequestInit,
    ) => Promise<Response>

  • OptionalfetchParams?: () => RequestInit

  • OptionalfilterHandler?: (url: URL, filterData: FilterData) => URL

  • OptionalonLoadBegin?: () => void

  • OptionalonLoadEnd?: (isOk: boolean) => void

  • Optionalorigin?: string

  • OptionalpaginationHandler?: (url: URL, pagination: ListHandlerPagination) => URL

  • OptionalremoveEmptyFilters?: (data: FilterData) => Partial<FilterData>

  • OptionalrequestMap?: (url: URL) => URL

  • OptionalresponseMap?: <T extends IRowData>(
        json: RowData[],
    ) => ListHandlerResult<T> | Promise<ListHandlerResult<T>>

  • OptionalsearchHandler?: (url: URL, search: string) => URL

  • OptionalsortHandler?: (url: URL, sort: ListHandlerSortModel<RowData>) => URL

  • OptionalwithAbortSignal?: boolean

  • OptionalwithChips?: boolean

  • OptionalwithFilters?: boolean

  • OptionalwithPagination?: boolean

  • OptionalwithSearch?: boolean

  • OptionalwithSort?: boolean