Class Multicast<A>

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

Properties

Methods

[asyncIterator] onStart? onStop? push

Constructors

constructor

new Multicast<A>(init?): Multicast<A>
Type Parameters
- A
Parameters
- init: (() => PushAdapter<A>) = ...
  - - (): PushAdapter<A>
    - Returns PushAdapter<A>
Returns Multicast<A>
- Defined in src/adapters/Multicast.ts:17

Properties

`Private` `Readonly` init

init: (() => PushAdapter<A>) = ...

Type declaration

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

`Readonly` receivers

receivers: Set<PushAdapter<A>> = ...

Methods

[asyncIterator]

[asyncIterator](): AsyncIterableIterator<A>
Creates and registers a receiver.

Returns AsyncIterableIterator<A>
Implementation of AsyncIterable.[asyncIterator]
- Defined in src/adapters/Multicast.ts:30

`Optional` onStart

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

`Optional` onStop

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

push

push(value): Multicast<A>
Pushes a value to all registered receivers.
Parameters
- value: A
Returns Multicast<A>
- Defined in src/adapters/Multicast.ts:22

Generated using TypeDoc