Interface: Stream<P, T, F> ​

Type parameters ​

Table of contents ​

Properties ​

• makeProducer
• stopProducer
• isFinite
• fold
• finished

Methods ​

• delayed
• first
• on
• merge
• enumerate
• tap
• filter
• filterMap
• map
• flatMap
• skip
• skipWhile
• take
• takeWhile
• takeWhileMap

Properties ​

makeProducer ​

• Readonly makeProducer: (onData: (data: P) => Promise<boolean>, onEnd: (eof: boolean) => void) => Promise<void>

Type declaration ​

▸ (onData, onEnd): Promise<void>

Parameters ​

Returns ​

Promise<void>

Defined in ​

src/stream.ts:295

stopProducer ​

• Readonly stopProducer: () => void

Type declaration ​

▸ (): void

Returns ​

void

Defined in ​

src/stream.ts:296

isFinite ​

• Readonly isFinite: F

Defined in ​

src/stream.ts:297

fold ​

• fold: F extends true ? <B>(init: B, f: (init: B, item: T) => B | Promise<B>) => Promise<B> : never

Folds every element into an accumulator by applying an operation, returning the final result

Defined in ​

src/stream.ts:312

finished ​

• finished: F extends true ? () => Promise<void> : never

Waits until the end of the stream

Defined in ​

src/stream.ts:317

Methods ​

delayed ​

▸ delayed<R>(f): Promise<() => R>

Waits until contract subscription is ready and then returns a promise with the result

Type parameters ​

Parameters ​

Returns ​

Promise<() => R>

Defined in ​

src/stream.ts:302

first ​

▸ first(): Promise<F extends true ? undefined | T : T>

Waits for the first element or the end of the stream

Returns ​

Promise<F extends true ? undefined | T : T>

Defined in ​

src/stream.ts:307

on ​

▸ on(handler): void

Executes handler on each item

Parameters ​

Returns ​

void

Defined in ​

src/stream.ts:322

merge ​

▸ merge<F1>(other): Stream<P, T, BothFinite<F, F1>>

Merges two streams

Type parameters ​

Parameters ​

Returns ​

Stream<P, T, BothFinite<F, F1>>

Defined in ​

src/stream.ts:327

enumerate ​

▸ enumerate(): Stream<P, { index: number ; item: T }, F>

Creates a stream which gives the current iteration count as well as the value

Returns ​

Stream<P, { index: number ; item: T }, F>

Defined in ​

src/stream.ts:332

tap ​

▸ tap(handler): Stream<P, T, F>

Alias for the .map((item) => { f(item); return item; })

Parameters ​

Returns ​

Stream<P, T, F>

Defined in ​

src/stream.ts:337

filter ​

▸ filter(f): Stream<P, T, F>

Skip elements where f(item) == false

Parameters ​

Returns ​

Stream<P, T, F>

Defined in ​

src/stream.ts:342

filterMap ​

▸ filterMap<U>(f): Stream<P, U, F>

Modifies items and skip all undefined

Type parameters ​

Parameters ​

Returns ​

Stream<P, U, F>

Defined in ​

src/stream.ts:347

map ​

▸ map<U>(f): Stream<P, U, F>

Modifies items

Type parameters ​

Parameters ​

Returns ​

Stream<P, U, F>

Defined in ​

src/stream.ts:352

flatMap ​

▸ flatMap<U>(f): Stream<P, U, F>

Creates an iterator that flattens nested structure

Type parameters ​

Parameters ​

Returns ​

Stream<P, U, F>

Defined in ​

src/stream.ts:357

skip ​

▸ skip(n): Stream<P, T, F>

Creates an iterator that skips the first n elements

Parameters ​

Returns ​

Stream<P, T, F>

Defined in ​

src/stream.ts:362

skipWhile ​

▸ skipWhile(f): Stream<P, T, F>

Creates an iterator that skips elements based on a predicate

Parameters ​

Returns ​

Stream<P, T, F>

Defined in ​

src/stream.ts:367

take ​

▸ take(n): Stream<P, T, true>

Creates an iterator that yields the first n elements, or fewer if the underlying iterator ends sooner

Parameters ​

Returns ​

Stream<P, T, true>

Defined in ​

src/stream.ts:372

takeWhile ​

▸ takeWhile(f): Stream<P, T, true>

Creates an iterator that yields elements based on a predicate

Parameters ​

Returns ​

Stream<P, T, true>

Defined in ​

src/stream.ts:377

takeWhileMap ​

▸ takeWhileMap<U>(f): Stream<P, U, true>

Creates an iterator that yields mapped elements based on a predicate until first undefined is found

Type parameters ​

Parameters ​

Returns ​

Stream<P, U, true>

Defined in ​

src/stream.ts:382