All files / src/types sort.types.ts

0% Statements 0/0
0% Branches 0/0
0% Functions 0/0
0% Lines 0/0

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61                                                                                                                         
/**
 * 排序类型定义
 */
 
/**
 * 排序方向
 */
export type SortOrder = 'asc' | 'desc';
 
/**
 * 排序参数
 *
 * 单字段排序参数
 *
 * @typeParam T - 排序字段类型
 */
export type SortParams<T extends string = string> = {
  /**
   * 排序字段
   */
  sortBy?: T;
 
  /**
   * 排序方向
   */
  sortOrder?: SortOrder;
};
 
/**
 * 多字段排序项
 *
 * 单个排序项定义
 *
 * @typeParam T - 排序字段类型
 */
export type SortItem<T extends string = string> = {
  /**
   * 排序字段
   */
  field: T;
 
  /**
   * 排序方向
   */
  order: SortOrder;
};
 
/**
 * 多字段排序参数
 *
 * 支持多个字段的排序
 *
 * @typeParam T - 排序字段类型
 */
export type MultiSortParams<T extends string = string> = {
  /**
   * 排序项数组
   */
  sort?: SortItem<T>[];
};