jz-tool-lib/dist/types/lib/usePage.d.ts

项目常用公共方法集合

/**
 * @description 带有分页的列表
 * @params {listApi} 接口
 * @params {props} 接口需要传的分页参数字段和默认值
 * @params {notExecute} 是否不执行
 * @params {paramsData} 默认参数
 * @params {conditionData} 条件参数
 * @return {getList} 获取列表
 * @return {pageData} 分页数据
 * @return {resetPageData} 重置分页参数
 * @return {resetPageSize} 重置当前页码参数
 * @return {resetPageNumber} 重置当前数量参数
 * @return {pageSizeChange} 改变每页数量
 * @return {pageNumberChange} 改变当前页码
 */
type PageProps = string | {
    name: string;
    default?: number;
};
type Params = Record<string, any>;
type SearchParams = {
    (): Params;
};
type Options = {
    listApi: {
        getData: (params: unknown) => Promise<any>;
        handleData: (data: any) => {
            list: unknown[];
            total: number;
        };
    };
    props?: {
        pageSize: PageProps;
        pageNumber: PageProps;
    };
    notExecute?: boolean;
    paramsData?: Params;
    conditionData?: Params;
    searchParams?: SearchParams;
};
export declare const usePage: (options: Options) => {
    getList: () => Promise<void>;
    pageData: {
        [x: string]: unknown;
        list: unknown[];
        pageTotal: number;
        pageSize: number;
        pageNumber: number;
    };
    resetPageData: () => Promise<void>;
    resetPageSize: () => Promise<void>;
    resetPageNumber: () => Promise<void>;
    pageSizeChange: (value: number) => Promise<void>;
    pageNumberChange: (value: number) => Promise<void>;
};
export {};