@sauce-api/core/dist/routes/canned/PaginationParams.js

Sauce API core functionality

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.getPaginationParams = exports.PaginationParams = void 0;
const RouteParam_1 = require("../RouteParam");
/**
 * @deprecated please use getPaginatedParams() instead of PaginationParams.
 * PaginationParams will be removed in a future release
*/
exports.PaginationParams = [
    new RouteParam_1.RouteParam()
        .setName("pageSize")
        .setDescription("The amount of items to return for each page")
        .setType("number")
        .setRequired(false),
    new RouteParam_1.RouteParam()
        .setName("page")
        .setType("number")
        .setRequired(false)
        .setDescription("The page number you're requesting")
];
const getPaginationParams = (max) => {
    return [
        new RouteParam_1.RouteParam()
            .setName("pageSize")
            .setDescription(`The amount of items to return for each page (max ${max || 50})`)
            .setType("number")
            .setRequired(false),
        new RouteParam_1.RouteParam()
            .setName("page")
            .setType("number")
            .setRequired(false)
            .setDescription("The page number you're requesting")
    ];
};
exports.getPaginationParams = getPaginationParams;