Interface Paginator<Entity, Params>

interface Paginator<Entity, Params = undefined> {
    "[asyncIterator]"(): AsyncIterator<
        Entity,
        undefined,
        string
        | Params
        | undefined,
    >;
    getDirection(): Direction;
    setDirection(direction: Direction): Paginator<Entity, Params>;
    values(): AsyncIterableIterator<Entity>;
}

Type Parameters

Entity
Params = undefined

Hierarchy

PromiseLike<Entity>
AsyncIterable<Entity>
- Paginator

Index

Methods

[asyncIterator] getDirection setDirection values

Methods

[asyncIterator]

"[asyncIterator]"(): AsyncIterator<
    Entity,
    undefined,
    string
    | Params
    | undefined,
>
Returns AsyncIterator<Entity, undefined, string | Params | undefined>
Overrides AsyncIterable.[asyncIterator]
- Defined in src/mastodon/paginator.ts:20

getDirection

getDirection(): Direction
Get the current direction of the paginator.

Returns Direction
The current direction of the paginator.
- Defined in src/mastodon/paginator.ts:9

setDirection

setDirection(direction: Direction): Paginator<Entity, Params>
Creates a new paginator with the given direction.
Parameters
- direction: Direction
  New direction of the paginator.
Returns Paginator<Entity, Params>
A new paginator with the given direction.
- Defined in src/mastodon/paginator.ts:16

values

values(): AsyncIterableIterator<Entity>
Returns AsyncIterableIterator<Entity>
- Defined in src/mastodon/paginator.ts:18