Interface

由于 POB SDK 是由 TypeScript 编写，我们将一些公共的 Interface 放到这里，以便大家查阅。

Response#

POB SDK 部分 API 返回的数据体数据格式。

interface Response<T> {
  status: 'success' | 'fail';
  msg: string;
  data: T;
}

PaginateResult#

POB SDK 部分 API 返回的分页数据格式。

interface PaginateResult<T> {
  docs: T[];
  totalDocs: number;
  limit: number;
  hasPrevPage: boolean;
  hasNextPage: boolean;
  page?: number | undefined;
  totalPages: number;
  offset: number;
  prevPage?: number | null | undefined;
  nextPage?: number | null | undefined;
  pagingCounter: number;
  meta?: any;
  [customLabel: string]: T[] | number | boolean | null | undefined;
}

TokenValue#

POB 返回的数据中涉及到金额的统一用 TokenValue 类型。

interface TokenValue {
  value: string;
  decimals: number;
}