pip-services3-commons-nodex/obj/src/data/DataPage.js

Portable abstractions and patterns for Pip.Services in Node.js / ES2017

"use strict";
/** @module data */
Object.defineProperty(exports, "__esModule", { value: true });
exports.DataPage = void 0;
/**
 * Data transfer object that is used to pass results of paginated queries.
 * It contains items of retrieved page and optional total number of items.
 *
 * Most often this object type is used to send responses to paginated queries.
 * Pagination parameters are defined by [[PagingParams]] object.
 * The <code>skip</code> parameter in the PagingParams there means how many items to skip.
 * The <code>takes</code> parameter sets number of items to return in the page.
 * And the optional <code>total</code> parameter tells to return total number of items in the query.
 *
 * Remember: not all implementations support the <code>total</code> parameter
 * because its generation may lead to severe performance implications.
 *
 * @see [[PagingParams]]
 *
 * ### Example ###
 *
 *     page := await myDataClient.getDataByFilter(
 *         "123",
 *         FilterParams.fromTuples("completed": true),
 *         new PagingParams(0, 100, true)
 *     );
 */
class DataPage {
    /**
     * Creates a new instance of data page and assigns its values.
     *
     * @param data      a list of items from the retrieved page.
     * @param total     (optional) .
     */
    constructor(data = null, total = null) {
        this.total = total;
        this.data = data;
    }
}
exports.DataPage = DataPage;
//# sourceMappingURL=DataPage.js.map