@stephansama packages / @stephansama/typed-events / message / createMessage
Function: createMessage()
ts
function createMessage<Name, Map>(name, map): object;Defined in: message.ts:23
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;window
Get Signature
ts
get window(): Window;Returns
Window
Set Signature
ts
set window(input): void;Parameters
input
Window
Returns
void
dispatch()
ts
dispatch<Event, Input>(
name,
input,
opts): void;Type Parameters
Event
Event extends string
Input
Input extends object
Parameters
name
Event
input
Input
opts
undefined | { origin: string; window: Window; }
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, "message">
Returns
ts
(): void;Returns
void