Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents a collection list response, with functionality for getting the next page when available.

param

The response "raw" list object.

param

A reference to the collection.

param

Any options that were passed at first to the get request.

Hierarchy

  • List

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

documents

documents: Document[]

options

options: any

ref

Methods

[Symbol.iterator]

  • [Symbol.iterator](): { next: any }
  • Returns { next: any }

    • next: function
      • next(): { done: boolean; value: Document } | { done: boolean }

getNextPage

  • getNextPage(): Promise<List>
  • Fetches the next page in the query

    Returns Promise<List>

Legend

Generated using TypeDoc