Skip to content

@epikodelabs/streamix


@epikodelabs/streamix / src/public-api / Stream

Type Alias: Stream<T> ​

Stream<T> = AsyncIterable<T> & object

Defined in: projects/libraries/streamix/src/lib/abstractions/stream.ts:13

A Stream is an async iterable with additional methods for piping, subscribing, and querying values.

Type Declaration ​

type ​

type: string

name? ​

optional name?: string

pipe ​

pipe: OperatorChain<T>

subscribe() ​

subscribe(callbackOrReceiver?): Subscription

Parameters ​

callbackOrReceiver? ​

((value) => any) | Receiver<T>

Returns ​

Subscription

query ​

query: () => Promise<T>

Returns ​

Promise<T>

toArray ​

toArray: () => Promise<T[]>

Returns ​

Promise<T[]>

[asyncIterator]() ​

[asyncIterator](): AsyncIterator<T>

Returns ​

AsyncIterator<T>

Type Parameters ​

T ​

T = any

The type of values emitted by the stream.

Released under the GNU AGPL v3 or later.