UNPKG

707 BTypeScriptView Raw
1/** @module data */
2import { SortField } from './SortField';
3/**
4 * Defines a field name and order used to sort query results.
5 *
6 * @see [[SortField]]
7 *
8 * ### Example ###
9 *
10 * let filter = FilterParams.fromTuples("type", "Type1");
11 * let paging = new PagingParams(0, 100);
12 * let sorting = new SortingParams(new SortField("create_time", true));
13 *
14 * myDataClient.getDataByFilter(filter, paging, sorting, (err, page) => {...});
15 */
16export declare class SortParams extends Array<SortField> {
17 /**
18 * Creates a new instance and initializes it with specified sort fields.
19 *
20 * @param fields a list of fields to sort by.
21 */
22 constructor(...fields: SortField[]);
23}