Interface MetaStreamOpts

Common base options for all stream / subscription types.

interface MetaStreamOpts {
    cache: boolean;
    closeIn: CloseMode;
    closeOut: CloseMode;
    emitLast: boolean;
    id: string;
}

Hierarchy (view full)

Properties

cache: boolean

If true (default), stream caches last received value and pushes it to new subscriberswhen they subscribe. If false, calling .deref() on this stream will always return undefined.

Default Value

true
closeIn: CloseMode

If false or CloseMode.NEVER, the stream stays active even if all inputs are done. If true (default) or CloseMode.LAST, the stream closes when the last input is done. If CloseMode.FIRST, the instance closes when the first input is done.

Default Value

CloseMode.LAST
closeOut: CloseMode

If false or CloseMode.NEVER, the stream stays active once there are no more subscribers. If true (default) or CloseMode.LAST, the stream closes when the last subscriber has unsubscribed. If CloseMode.FIRST, the instance closes when the first subscriber disconnects.

Default Value

CloseMode.LAST
emitLast: boolean

If true, emits the last received value from the metastream's current child stream (if any) when the metastream's parent is calling .done().

Default Value

false
id: string

Internal ID associated with this stream. If omitted, an autogenerated ID will be used.

Generated using TypeDoc