@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
48 lines (47 loc) • 1.04 kB
TypeScript
/**
* Common interface for metadata.
*/
export interface IMetaData {
/**
* Indicates if the data is paged.
*/
isPaged: boolean;
/**
* The record number of the first record of a page.
*/
record: number;
/**
* The current page.
*/
page: number;
/**
* The page size of the returned set.
*/
pageSize: number;
/**
* The total number of records available on the backend.
*/
totalRecords: number;
/**
* The total number of pages of records on the backend.
*/
totalPages: number;
/**
* Indicates if the data set is filtered.
*/
isFiltered: boolean;
/**
* Number of records available before the filter was processed.
*/
recordsBeforeFilter: number;
/**
* Indicates the response was the result of a batch API.
*/
batch: boolean;
/**
* A collection of the other less common or custom UAPI metadata properties.
*/
properties: {
[index: string]: string;
};
}