Class BaseTableUtils

constructor

• new BaseTableUtils(): BaseTableUtils

  Returns BaseTableUtils

StaticPaginationSchema

StaticbodyParams

• bodyParams(param: { [key: string]: SSchemaEl } | undefined): SSchemaElObj

  Creates a new schema element object that combines the default core body parameters with the provided properties.

  Parameters

  • param: { [key: string]: SSchemaEl } | undefined

    The properties to merge into the core body parameters.

  Returns SSchemaElObj

  The merged schema element object.

StaticcalcPages

• calcPages(query: TableQueryType, total: number): Paging

  Parameters

  • query: TableQueryType
  • total: number

  Returns Paging

StaticqueryParams

• queryParams(...param: SwaggerRPathParameter[]): SwaggerRPathParameter[]

  Builds a Swagger parameter list that includes standard pagination and sorting options

  Parameters

  • ...param: SwaggerRPathParameter[]

    Existing query parameters to be appended.

  Returns SwaggerRPathParameter[]

  An array of Swagger parameters containing the provided parameters plus the optional query parameters page, pageSize, sortBy, and sortDesc.

StatictableFieldBody

• tableFieldBody(
      __namedParameters: XActionEvent,
      allowedSort?: string[],
      allowedFields?: string[],
      maxPageSize?: number,
  ): TableQueryType | null

  Parameters

  • __namedParameters: XActionEvent
  • OptionalallowedSort: string[]
  • allowedFields: string[] = []
  • maxPageSize: number = 100

  Returns TableQueryType | null

StatictableFieldQuery

• tableFieldQuery(
      __namedParameters: XActionEvent,
      allowedSort?: string[],
      allowedFields?: string[],
      maxPageSize?: number,
  ): TableQueryType | null

  Parameters

  • __namedParameters: XActionEvent
  • OptionalallowedSort: string[]
  • allowedFields: string[] = []
  • maxPageSize: number = 100

  Returns TableQueryType | null

StatictableSchema

• tableSchema(schema: SSchemaEl): SSchemaElObj

  Creates a JSON schema that represents a paginated table response.

  Parameters

  • schema: SSchemaEl

    The schema for each element in the data array.

  Returns SSchemaElObj

  A schema object that validates an object containing the properties:

  • data: an array of items matching the provided schema
  • total: an integer indicating the total number of items
  • page: an integer indicating the current page number
  • maxPage: an integer indicating the maximum number of pages