refactor: perPage to pageSize (#197)

This commit is contained in:
ChengLei Shao 2022-02-18 09:46:10 +08:00 committed by GitHub
parent acf459d5df
commit 6c381313cb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 15 additions and 15 deletions

View File

@ -53,7 +53,7 @@ interface ActionParams {
filterByTk?: any; filterByTk?: any;
sort?: string[]; sort?: string[];
page?: number; page?: number;
perPage?: number; pageSize?: number;
values?: any; values?: any;
/** /**
* @deprecated * @deprecated

View File

@ -87,7 +87,7 @@ describe('list action', () => {
.resource('posts') .resource('posts')
.list({ .list({
fields: ['id'], fields: ['id'],
perPage: 1, pageSize: 1,
page: 2, page: 2,
sort: ['id'], sort: ['id'],
}); });

View File

@ -6,23 +6,23 @@ export const DEFAULT_PER_PAGE = 20;
function pageArgsToLimitArgs( function pageArgsToLimitArgs(
page: number, page: number,
perPage: number, pageSize: number,
): { ): {
offset: number; offset: number;
limit: number; limit: number;
} { } {
return { return {
offset: (page - 1) * perPage, offset: (page - 1) * pageSize,
limit: perPage, limit: pageSize,
}; };
} }
function totalPage(total, perPage): number { function totalPage(total, pageSize): number {
return Math.ceil(total / perPage); return Math.ceil(total / pageSize);
} }
export async function list(ctx: Context, next) { export async function list(ctx: Context, next) {
const { page = DEFAULT_PAGE, perPage = DEFAULT_PER_PAGE, fields, filter, appends, except, sort } = ctx.action.params; const { page = DEFAULT_PAGE, pageSize = DEFAULT_PER_PAGE, fields, filter, appends, except, sort } = ctx.action.params;
const repository = getRepositoryFromParams(ctx); const repository = getRepositoryFromParams(ctx);
@ -32,15 +32,15 @@ export async function list(ctx: Context, next) {
appends, appends,
except, except,
sort, sort,
...pageArgsToLimitArgs(parseInt(String(page)), parseInt(String(perPage))), ...pageArgsToLimitArgs(parseInt(String(page)), parseInt(String(pageSize))),
}); });
ctx.body = { ctx.body = {
count, count,
rows, rows,
page, page,
perPage, pageSize,
totalPage: totalPage(count, perPage), totalPage: totalPage(count, pageSize),
}; };
await next(); await next();

View File

@ -89,11 +89,11 @@ export interface ActionOptions {
/** /**
* *
*/ */
perPage?: number; pageSize?: number;
/** /**
* *
*/ */
maxPerPage?: number; maxPageSize?: number;
/** /**
* *
*/ */
@ -155,7 +155,7 @@ export interface ActionParams {
/** /**
* *
*/ */
perPage?: number; pageSize?: number;
/** /**
* options.defaultValues + request.body * options.defaultValues + request.body
*/ */

View File

@ -9,7 +9,7 @@ interface ActionParams {
filter?: any; filter?: any;
sort?: string[]; sort?: string[];
page?: number; page?: number;
perPage?: number; pageSize?: number;
values?: any; values?: any;
/** /**
* @deprecated * @deprecated