@resourge/react-fetch/dist/types/PaginationConfig.d.ts

[](LICENSE)

/**
 * react-fetch v1.41.3
 *
 * Copyright (c) resourge.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE.md file in the root directory of this source tree.
 *
 * @license MIT
 */
import { type FetchStateConfig } from '../hooks';
import { type PreloadConfig } from '../hooks/usePreload';
import { type PaginationSearchParamsType, type SortSearchParamsType } from './ParamsType';
import { type DeepPartial } from './types';
export type PaginationMetadata<FilterSearchParams extends Record<string, any> = Record<string, any>> = {
    filter: FilterSearchParams;
    pagination: PaginationSearchParamsType;
} & SortSearchParamsType;
export type ResetPaginationMetadataType<FilterSearchParams extends Record<string, any> = Record<string, any>> = DeepPartial<PaginationMetadata<FilterSearchParams>>;
export type PaginationConfig<Data, FilterSearchParams extends Record<string, any> = Record<string, any>> = SortSearchParamsType & {
    filter?: FilterSearchParams;
} & FetchStateConfig<Data> & {
    /**
     * Optional unique identifier to namespace multiple filter states in the URL.
     *
     * When two or more instances of useInfiniteLoading and/or usePagination are used in the same page,
     * this ID helps prevent conflicts by grouping related search parameters together.
     * If not provided, a unique ID will be automatically generated.
     */
    fId?: string;
    hash?: boolean;
    /**
     * Initial page starts with 0, but can be overwrite.
     * @default 0
     */
    initialPage?: number;
    /**
     * Initial per page starts with 10, but can be overwrite.
     * @default 10
     */
    initialPerPage?: number;
    preload?: PreloadConfig;
};