Interface PaginatedAsyncIterable<T>

interface PaginatedAsyncIterable<T> {
    "[asyncIterator]"(): AsyncIterator<T, any, any>;
    page(offset?: number): Promise<PageShape<T>>;
    toArray(maxItems?: number): Promise<T[]>;
}

Type Parameters

  • T

Hierarchy

  • AsyncIterable<T>
    • PaginatedAsyncIterable

Methods

[asyncIterator] page toArray

Methods

[asyncIterator]

  • "[asyncIterator]"(): AsyncIterator<T, any, any>

    Returns AsyncIterator<T, any, any>

page

  • page(offset?: number): Promise<PageShape<T>>

    Parameters

    • Optionaloffset: number

    Returns Promise<PageShape<T>>

toArray

  • toArray(maxItems?: number): Promise<T[]>

    Parameters

    • OptionalmaxItems: number

    Returns Promise<T[]>

Settings

Member Visibility

On This Page

Methods