Documentation

Mistake on this page? Email us

Type parameters

  • T

Hierarchy

  • Page

Implements

  • IterableIterator<T>

Index

Constructors

constructor

  • new Page(from: any, data?: Array<T>, apiMapper?: function, listOptions?: ListOptions): Page
  • Parameters

    • from: any
    • Optional data: Array<T>
    • Optional apiMapper: function
        • (key: T, index?: number): T
        • Parameters

          • key: T
          • Optional index: number

          Returns T

    • Optional listOptions: ListOptions

    Returns Page

Properties

after

after: string

Entity id for fetch after it

continuationMarker

continuationMarker: string

Entity id for fetch after it

hasMore

hasMore: boolean

Whether there are more results to display

order

order: Order

Order of returned records

pageSize

pageSize: number

The page size

totalCount

totalCount: number

Total number of records (Approximate number of results according to the API)

Accessors

data

data:

The data in the page

Methods

__@iterator

  • __@iterator(): IterableIterator<T>
  • Returns IterableIterator<T>

first

  • first(): T
  • Returns T

last

  • last(): T
  • Returns T

mapData

  • mapData<U>(mapFunc: function): Array<U>
  • Type parameters

    • U

    Parameters

    • mapFunc: function
        • (key: any, index?: number): U
        • Parameters

          • key: any
          • Optional index: number

          Returns U

    Returns Array<U>

next

  • next(): IteratorResult<T>
  • Returns IteratorResult<T>

return

  • return(value?: T): IteratorResult<T>
  • Parameters

    • Optional value: T

    Returns IteratorResult<T>

throw

  • throw(e?: any): IteratorResult<T>
  • Parameters

    • Optional e: any

    Returns IteratorResult<T>