Class StreamPagination

StreamPagination object is used to fetch all streams that satisfy the given filters.

NOTE: You need to call StreamPagination.initialize before doing any other operations.

Hierarchy

  • StreamPagination

Properties

filters?: StreamFilters

The stream filters. Only streams that satisfy the given filters are returned.

Methods

  • Initialize a StreamPagination object.

    Returns Promise<void>

  • Refresh all the streams and the StreamPagination object.

    Returns Promise<void>

  • Get the total number of streams.

    Returns number

    The total number of streams.

    Throws

    An error is thrown is the StreamPagination object is not initialized

  • Get the streams.

    Parameters

    Returns Promise<(undefined | Stream)[]>

    The streams

    Throws

    An error is thrown is the StreamPagination object is not initialized or options value is invalid.

Generated using TypeDoc