Skip to content

@epikodelabs/streamix


@epikodelabs/streamix / Stream

Type Alias: Stream<T>

Stream<T> = AsyncIterable<T> & object

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

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

Type declaration

type

type: "stream" | "subject"

name?

optional name: string

id

id: string

pipe

pipe: OperatorChain<T>

subscribe()

subscribe: (callback?) => Subscription

Parameters

callback?

(value) => MaybePromise | Receiver<T>

Returns

Subscription

query()

query: () => 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 MIT License.