Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents the configuration for a page of elements. Created by the middleware based on the request query parameters

param

The page to be returned

param

The number of elements to be returned

param

The format to return the results in. If true and the type of the content being returned supports it (has an id property), the result will contain a (potentially ordered, based on sort) list of ids and a corresponding map of {id: content item}, else content returned as a simple array. Default value is false.

param

Optional. The order to return the results in, ordered list of property, Direction.

Hierarchy

  • Pageable

Index

Constructors

Properties

Constructors

constructor

  • new Pageable(pageNumber?: number, pageSize?: number, indexed?: boolean, sort?: string | Array<string> | Sort): Pageable
  • Parameters

    • Default value pageNumber: number = 0
    • Default value pageSize: number = 20
    • Default value indexed: boolean = false
    • Optional sort: string | Array<string> | Sort

    Returns Pageable

Properties

indexed

indexed: boolean

If true and the type of the content being returned supports it (has an id property), the resulting Page will be of type IndexedPage and will contain a (potentially ordered, based on sort) list of ids and a corresponding map of {id : content item}, else the page will be of type {@ArrayPage} and content will be returned as a simple array.

page

page: number

The number of the Page to be returned

size

size: number

The number of elements in the Page to be returned

Optional sort

sort: Sort

The order of the elements in the Page to be returned

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc