Interface IStream<T, U>

An object that is both a signal and an async iterable.

interface IStream<T, U> {
    [asyncIterator](): AsyncIterator<U, any, undefined>;
    connect(slot, thisArg?): boolean;
    disconnect(slot, thisArg?): boolean;
}

Type Parameters

T
U

Hierarchy (view full)

ISignal<T, U>
AsyncIterable<U>
- IStream

Implemented by

Stream

Index

Methods

[asyncIterator] connect disconnect

Methods

[asyncIterator]

[asyncIterator](): AsyncIterator<U, any, undefined>
Returns AsyncIterator<U, any, undefined>
Inherited from AsyncIterable.[asyncIterator]
- Defined in node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:38

connect

connect(slot, thisArg?): boolean
Connect a slot to the signal.
Parameters
- slot: Slot<T, U>
  The slot to invoke when the signal is emitted.
- Optional thisArg: any
  The this context for the slot. If provided, this must be a non-primitive object.
Returns boolean
true if the connection succeeds, false otherwise.

Notes
Slots are invoked in the order in which they are connected.

Signal connections are unique. If a connection already exists for the given slot and thisArg, this method returns false.

A newly connected slot will not be invoked until the next time the signal is emitted, even if the slot is connected while the signal is dispatching.
Inherited from ISignal.connect
- Defined in packages/signaling/src/index.ts:59

disconnect

disconnect(slot, thisArg?): boolean
Disconnect a slot from the signal.
Parameters
- slot: Slot<T, U>
  The slot to disconnect from the signal.
- Optional thisArg: any
  The this context for the slot. If provided, this must be a non-primitive object.
Returns boolean
true if the connection is removed, false otherwise.

Notes
If no connection exists for the given slot and thisArg, this method returns false.

A disconnected slot will no longer be invoked, even if the slot is disconnected while the signal is dispatching.
Inherited from ISignal.disconnect
- Defined in packages/signaling/src/index.ts:78