@stephansama packages / @stephansama/typed-events / index / ValidatorMap

Interface: ValidatorMap<Name, Map, EventTypeKeys, DispatchOpts>

Defined in: utils/types.ts:39

Extended by

• TypedBroadcastEvent
• TypedBroadcastChannel
• TypedEventMap
• TypedMessage

Type Parameters

Name

Name extends string

Map

Map extends Record<string, StandardSchemaV1>

EventTypeKeys

EventTypeKeys extends keyof RawEventMap

DispatchOpts

DispatchOpts = { }

Properties

map

map: Map;

Defined in: utils/types.ts:62

---

name

name: Name;

Defined in: utils/types.ts:63

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?

DispatchOpts

Returns

void

---

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, EventTypeKeys>

Returns

(): void;

Returns

void