Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PagingOptions

Hierarchy

  • PagingOptions

Index

Constructors

Properties

Methods

Constructors

constructor

  • new PagingOptions(itemOffset?: number, maxPageSize?: number, sort?: string): PagingOptions
  • Parameters

    • Optional itemOffset: number
    • Optional maxPageSize: number
    • Optional sort: string

    Returns PagingOptions

Properties

Optional filters

filters: object

Key value object representing filter name and it is value { category_id: XXXXX }

Optional itemOffset

itemOffset: number

Optional maxPageSize

maxPageSize: number

How many items you want to fetch per page.

Optional page

page: number

The page that should be fetched. ZERO-based - this means page 0 will contain records 1-10 for a maxPageSize of 10

Optional sort

sort: string

Sort order criteria, prefixed property name(s) either single or comma seperated "category_order, interest_name"

Methods

Static toQueryParams

  • toQueryParams(pagingOptions: PagingOptions, queryParams?: any): object
  • Parameters

    • pagingOptions: PagingOptions
    • Optional queryParams: any

    Returns object

Generated using TypeDoc