@stephansama packages / @stephansama/typed-events / broadcast / TypedBroadcastChannel

Interface: TypedBroadcastChannel<Name, Map>

Defined in: broadcast.ts:7

Extends

• ValidatorMap<Name, Map, "message">

Type Parameters

Name

Name extends string

Map

Map extends Record<string, StandardSchemaV1>

Properties

channel

readonly channel: BroadcastChannel;

Defined in: broadcast.ts:11

---

id

readonly id: `${string}-${string}-${string}-${string}-${string}`;

Defined in: broadcast.ts:12

---

map

map: Map;

Defined in: utils/types.ts:62

Inherited from

ValidatorMap.map

---

name

name: Name;

Defined in: utils/types.ts:63

Inherited from

ValidatorMap.name

Methods

dispatch()

dispatch<Event, Input>(
   name, 
   input, 
   opts?): void;

Defined in: utils/types.ts:45

Type Parameters

Event

Event extends string

Input

Input extends object

Parameters

name

Event

input

Input

opts?

Returns

void

Inherited from

ValidatorMap.dispatch

---

listen()

listen<Event, Input>(name, callback): () => void;

Defined in: utils/types.ts:54

Type Parameters

Event

Event extends string

Input

Input extends object

Parameters

name

Event

callback

ListenerCallback<Input, "message">

Returns

(): void;

Returns

void

Inherited from

ValidatorMap.listen