@cpanel/api
Version:
cPanel API JavaScript and TypeScript interface libraries. This library provides a set of classes for calling cPanel WHM API 1 and UAPI calls. The classes hide much of the complexity of these APIs behind classes the abstract the underlying variances betwee
58 lines • 2.51 kB
JavaScript
// MIT License
//
// Copyright 2021 cPanel L.L.C.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
export const DEFAULT_PAGE_SIZE = 20;
/**
* When passed in the pageSize, will request all available records in a single page. Note: The backend process may not honor this request.
*/
export const ALL = Number.POSITIVE_INFINITY;
/**
* Defines a pagination request for an API.
*/
export class Pager {
/**
* Create a new pagination object.
*
* @param page Page to request. From 1 .. n where n is the set.length % pageSize. Defaults to 1.
* @param pageSize Number of records to request in a page of data. Defaults to DEFAULT_PAGE_SIZE.
* If the string 'all' is passed, then all the records are requested. Note: The backend
* system may still impose page size limits in this case.
*/
constructor(page = 1, pageSize = DEFAULT_PAGE_SIZE) {
if (page <= 0) {
throw new Error("The page must be 1 or greater. This is the logical page, not a programming index.");
}
if (pageSize <= 0) {
throw new Error("The pageSize must be set to 'ALL' or a number > 0");
}
this.page = page;
this.pageSize = pageSize;
}
/**
* Check if the pagesize is set to ALL.
*
* @return true if requesting all records, false otherwise.
*/
all() {
return this.pageSize === ALL;
}
}
//# sourceMappingURL=pager.js.map