Multicast | queueable

Multicasts pushed values to a variable number of async iterable iterators as receivers or subscribers.

Does not buffer pushed values; if no receivers are registered, pushed values are silently discarded.

Type parameters

A

Hierarchy

Multicast

Implements

AsyncIterable<A>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Multicast(init?: () => PushAdapter<A>): Multicast

- Defined in src/adapters/Multicast.ts:15
Parameters
- Default value init: () => PushAdapter<A> = () => new Channel()
  - - (): PushAdapter<A>
    - Returns PushAdapter<A>
Returns Multicast

Properties

Private Readonly init

init: () => PushAdapter<A>

Type declaration

- (): PushAdapter<A>
- Returns PushAdapter<A>

Readonly receivers

receivers: Set<PushAdapter<A>> = new Set()

Methods

[Symbol.asyncIterator]

[Symbol.asyncIterator](): AsyncIterableIterator<A>

- Defined in src/adapters/Multicast.ts:30
Creates and registers a receiver.

Returns AsyncIterableIterator<A>

Optional onStart

onStart(): void

- Defined in src/adapters/Multicast.ts:12
Returns void

Optional onStop

onStop(): void

- Defined in src/adapters/Multicast.ts:13
Returns void

push

push(value: A): this

- Defined in src/adapters/Multicast.ts:22
Pushes a value to all registered receivers.

Parameters
- value: A
Returns this

Generated using TypeDoc