Files
outline/server/routes/api/middlewares/pagination.ts

60 lines
1.5 KiB
TypeScript

import querystring from "querystring";
import { Context, Next } from "koa";
import { InvalidRequestError } from "@server/errors";
export default function pagination(options?: Record<string, any>) {
return async function paginationMiddleware(ctx: Context, next: Next) {
const opts = {
defaultLimit: 15,
defaultOffset: 0,
maxLimit: 100,
...options,
};
const query = ctx.request.query;
const body = ctx.request.body;
let limit = query.limit || body.limit;
let offset = query.offset || body.offset;
if (limit && isNaN(limit)) {
throw InvalidRequestError(`Pagination limit must be a valid number`);
}
if (offset && isNaN(offset)) {
throw InvalidRequestError(`Pagination offset must be a valid number`);
}
limit = parseInt(limit || opts.defaultLimit, 10);
offset = parseInt(offset || opts.defaultOffset, 10);
if (limit > opts.maxLimit) {
throw InvalidRequestError(
`Pagination limit is too large (max ${opts.maxLimit})`
);
}
if (limit <= 0) {
throw InvalidRequestError(`Pagination limit must be greater than 0`);
}
if (offset < 0) {
throw InvalidRequestError(
`Pagination offset must be greater than or equal to 0`
);
}
ctx.state.pagination = {
limit,
offset,
};
query.limit = ctx.state.pagination.limit;
query.offset = ctx.state.pagination.offset + query.limit;
ctx.state.pagination.nextPath = `/api${
ctx.request.path
}?${querystring.stringify(query)}`;
return next();
};
}