Skip to main content
Version: v1

Queue Class

Helper queue class to allow async push / pull It's essentially a pipe allowing multiple writers, and single reader

Signature

export declare class Queue<T> implements IStream<T>

Implements: IStream

Type Parameters

ParameterDescription
T

Methods

MethodReturn TypeDescription
pushCore(value)void
pushDone()void
pushError(error)void
pushValue(value)void
read()Promise<IStreamResult<T>>

Method Details

pushCore

Signature

protected pushCore(value: Promise<IStreamResult<T>>): void;

Parameters

ParameterTypeDescription
valuePromise<IStreamResult<T>>

pushDone

Signature

pushDone(): void;

pushError

Signature

pushError(error: any): void;

Parameters

ParameterTypeDescription
errorany

pushValue

Signature

pushValue(value: T): void;

Parameters

ParameterTypeDescription
valueT

read

Signature

read(): Promise<IStreamResult<T>>;

Returns

Return type: Promise<IStreamResult<T>>