Skip to content

@stephansama packages / @stephansama/typed-events / event-map / createEventMap

Function: createEventMap()

ts
function createEventMap<Name, Map>(name, map): object;

Defined in: event-map.ts:18

Type Parameters

Name

Name extends string

Map

Map extends Record<string, StandardSchemaV1<unknown, unknown>>

Parameters

name

Name

map

Map

Returns

object

map

ts
map: Map;

name

ts
name: Name;

target

Get Signature

ts
get target(): EventTarget;
Returns

EventTarget

Set Signature

ts
set target(target): void;
Parameters
target

EventTarget

Returns

void

dispatch()

ts
dispatch<Event, Input>(name, detail): void;

Type Parameters

Event

Event extends string

Input

Input extends object

Parameters

name

Event

detail

Input

Returns

void

listen()

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

Type Parameters

Event

Event extends string

Input

Input extends object

Parameters

name

Event

callback

ListenerCallback<Input, "event">

Returns

ts
(): void;
Returns

void

Released under MIT license