Interface Stream<P, T, F>

Type Parameters

P
T
F extends boolean = false

Hierarchy

Stream

Index

Properties

makeProducer stopProducer isFinite fold finished

Methods

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

Properties

`Readonly` makeProducer

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

Type declaration

- (onData: ((data: P) => Promise<boolean>), onEnd: ((eof: boolean) => void)): Promise<void>
- Parameters
 - onData: ((data: P) => Promise<boolean>)
 - (data: P): Promise<boolean>
 
 Parameters
 
 data: P
 
 Returns Promise<boolean>
 - onEnd: ((eof: boolean) => void)
 - (eof: boolean): void
 
 Parameters
 
 eof: boolean
 
 Returns void
 Returns Promise<void>

`Readonly` stopProducer

stopProducer: (() => void)

Type declaration

- (): void
- Returns void

`Readonly` isFinite

isFinite: F

fold

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

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

finished

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

Waits until the end of the stream

Methods

delayed

delayed<R>(f: ((stream: Delayed<P, T, F>) => DelayedPromise<R>)): Promise<(() => R)>
Waits until contract subscription is ready and then returns a promise with the result
Type Parameters
- R
Parameters
- f: ((stream: Delayed<P, T, F>) => DelayedPromise<R>)
 - - (stream: Delayed<P, T, F>): DelayedPromise<R>
 - Parameters
 
 stream: Delayed<P, T, F>
 
 Returns DelayedPromise<R>
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: ((item: T) => void | Promise<void>)): void
Executes handler on each item
Parameters
- handler: ((item: T) => void | Promise<void>)
 - - (item: T): void | Promise<void>
 - Parameters
 
 item: T
 
 Returns void | Promise<void>
Returns void
- Defined in src/stream.ts:322

merge

merge<F1>(other: Stream<P, T, F1>): Stream<P, T, BothFinite<F, F1>>
Merges two streams
Type Parameters
- F1 extends boolean
Parameters
- other: Stream<P, T, F1>
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: ((item: T) => void | Promise<void>)): Stream<P, T, F>
Alias for the .map((item) => { f(item); return item; })
Parameters
- handler: ((item: T) => void | Promise<void>)
 - - (item: T): void | Promise<void>
 - Parameters
 
 item: T
 
 Returns void | Promise<void>
Returns Stream<P, T, F>
- Defined in src/stream.ts:337

filter

filter(f: ((item: T) => boolean | Promise<boolean>)): Stream<P, T, F>
Skip elements where f(item) == false
Parameters
- f: ((item: T) => boolean | Promise<boolean>)
 - - (item: T): boolean | Promise<boolean>
 - Parameters
 
 item: T
 
 Returns boolean | Promise<boolean>
Returns Stream<P, T, F>
- Defined in src/stream.ts:342

filterMap

filterMap(f: ((item: T) => undefined | U | Promise<undefined | U>)): Stream<P, U, F>
Modifies items and skip all undefined
Type Parameters
- U
Parameters
- f: ((item: T) => undefined | U | Promise<undefined | U>)
 - - (item: T): undefined | U | Promise<undefined | U>
 - Parameters
 
 item: T
 
 Returns undefined | U | Promise<undefined | U>
Returns Stream<P, U, F>
- Defined in src/stream.ts:347

map

map(f: ((item: T) => U | Promise)): Stream<P, U, F>
Modifies items
Type Parameters
- U
Parameters
- f: ((item: T) => U | Promise)
 - - (item: T): U | Promise
 - Parameters
 
 item: T
 
 Returns U | Promise
Returns Stream<P, U, F>
- Defined in src/stream.ts:352

flatMap

flatMap(f: ((item: T) => U[] | Promise<U[]>)): Stream<P, U, F>
Creates an iterator that flattens nested structure
Type Parameters
- U
Parameters
- f: ((item: T) => U[] | Promise<U[]>)
 - - (item: T): U[] | Promise<U[]>
 - Parameters
 
 item: T
 
 Returns U[] | Promise<U[]>
Returns Stream<P, U, F>
- Defined in src/stream.ts:357

skip

skip(n: number): Stream<P, T, F>
Creates an iterator that skips the first n elements
Parameters
- n: number
Returns Stream<P, T, F>
- Defined in src/stream.ts:362

skipWhile

skipWhile(f: ((item: T) => boolean | Promise<boolean>)): Stream<P, T, F>
Creates an iterator that skips elements based on a predicate
Parameters
- f: ((item: T) => boolean | Promise<boolean>)
 - - (item: T): boolean | Promise<boolean>
 - Parameters
 
 item: T
 
 Returns boolean | Promise<boolean>
Returns Stream<P, T, F>
- Defined in src/stream.ts:367

take

take(n: number): Stream<P, T, true>
Creates an iterator that yields the first n elements, or fewer if the underlying iterator ends sooner
Parameters
- n: number
Returns Stream<P, T, true>
- Defined in src/stream.ts:372

takeWhile

takeWhile(f: ((item: T) => boolean | Promise<boolean>)): Stream<P, T, true>
Creates an iterator that yields elements based on a predicate
Parameters
- f: ((item: T) => boolean | Promise<boolean>)
 - - (item: T): boolean | Promise<boolean>
 - Parameters
 
 item: T
 
 Returns boolean | Promise<boolean>
Returns Stream<P, T, true>
- Defined in src/stream.ts:377

takeWhileMap

takeWhileMap(f: ((item: T) => undefined | U | Promise<undefined | U>)): Stream<P, U, true>
Creates an iterator that yields mapped elements based on a predicate until first undefined is found
Type Parameters
- U
Parameters
- f: ((item: T) => undefined | U | Promise<undefined | U>)
 - - (item: T): undefined | U | Promise<undefined | U>
 - Parameters
 
 item: T
 
 Returns undefined | U | Promise<undefined | U>
Returns Stream<P, U, true>
- Defined in src/stream.ts:382

Interface Stream<P, T, F>

Type Parameters

P

T

F extends boolean = false

Hierarchy

Index

Properties

Methods

Properties

Readonly makeProducer

Type declaration

Parameters

onData: ((data: P) => Promise<boolean>)

Parameters

data: P

Returns Promise<boolean>

onEnd: ((eof: boolean) => void)

Parameters

eof: boolean

Returns void

Returns Promise<void>

Readonly stopProducer

Type declaration

Returns void

Readonly isFinite

fold

finished

Methods

delayed

Type Parameters

R

Parameters

f: ((stream: Delayed<P, T, F>) => DelayedPromise<R>)

Parameters

stream: Delayed<P, T, F>

Returns DelayedPromise<R>

Returns Promise<(() => R)>

first

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

on

Parameters

handler: ((item: T) => void | Promise<void>)

Parameters

item: T

Returns void | Promise<void>

Returns void

merge

Type Parameters

F1 extends boolean

Parameters

other: Stream<P, T, F1>

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

enumerate

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

tap

Parameters

handler: ((item: T) => void | Promise<void>)

Parameters

item: T

Returns void | Promise<void>

Returns Stream<P, T, F>

filter

Parameters

f: ((item: T) => boolean | Promise<boolean>)

Parameters

item: T

Returns boolean | Promise<boolean>

Returns Stream<P, T, F>

filterMap

Type Parameters

U

Parameters

f: ((item: T) => undefined | U | Promise<undefined | U>)

Parameters

item: T

Returns undefined | U | Promise<undefined | U>

Returns Stream<P, U, F>

map

Type Parameters

`Readonly` makeProducer

`Readonly` stopProducer

`Readonly` isFinite

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