@epikodelabs/streamix

---

@epikodelabs/streamix / Stream

Type Alias: Stream<TIn, TOut>

Stream<TIn, TOut> = AsyncIterable<TOut> & 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: "stream" | "subject"

name?

optional name: string

pipe

pipe: OperatorChain<TOut>

subscribe()

subscribe(callbackOrReceiver?): Subscription

Parameters

callbackOrReceiver?

(value) => any | Receiver<TOut>

Returns

Subscription

query()

query: () => Promise<TOut>

Returns

Promise<TOut>

[asyncIterator]()

[asyncIterator](): AsyncIterator<TOut>

Returns

AsyncIterator<TOut>

Type Parameters

TIn

TIn = any

TOut

TOut = TIn

Template

The type of values emitted by the stream.