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

Index

Properties

Methods

initialize refresh totalStreams getStreams

Properties

`Optional` `Readonly` filters

filters?: StreamFilters

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

Methods

`Readonly` initialize

initialize(): Promise<void>
Initialize a StreamPagination object.

Returns Promise<void>
- Defined in pagination.ts:51

`Readonly` refresh

refresh(): Promise<void>
Refresh all the streams and the StreamPagination object.

Returns Promise<void>
- Defined in pagination.ts:61

`Readonly` totalStreams

totalStreams(): number
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
- Defined in pagination.ts:85

`Readonly` getStreams

getStreams(options): Promise<(undefined | Stream)[]>
Get the streams.
Parameters
- options: StreamPaginationOptions
  
  The stream pagination options. Look at StreamPaginationOptions for more details
Returns Promise<(undefined | Stream)[]>
The streams

Throws
An error is thrown is the StreamPagination object is not initialized or options value is invalid.
- Defined in pagination.ts:99

Generated using TypeDoc