Interface AsyncSink<Y, R, E>

Write-side of an async channel that pushes values, completion, or errors.

See

AsyncSource for the read-side counterpart.
AsyncChannel for the combined read/write interface.

Example

declare const sink: AsyncSink<number, string>;
sink.next(1);
sink.next(2);
sink.complete("done");

interface AsyncSink<Y, R = void, E = unknown> {
    complete(...args: OptionalIfVoid<R>): void;
    error(err: E): void;
    next(y: Y): void;
}

Type Parameters

Y
Yielded value type.
R = void
Return value type.
E = unknown
Error type (default: unknown).

Hierarchy (View Summary)

AsyncSink
- AsyncChannel

Index

Methods

complete error next

Methods

complete

complete(...args: OptionalIfVoid<R>): void
Completes the channel with a return value.
Parameters
- ...args: OptionalIfVoid<R>
Returns void
Remarks
The argument is optional when R is void or undefined.
- Defined in src/iterator/channel/type.ts:31

error

error(err: E): void
Terminates the channel with an error.
Parameters
- err: E
Returns void
- Defined in src/iterator/channel/type.ts:33

next

next(y: Y): void
Pushes a yielded value into the channel.
Parameters
- y: Y
Returns void
- Defined in src/iterator/channel/type.ts:24