@stephansama packages / @stephansama/typed-events / broadcast-event / createBroadcastEvent
Function: createBroadcastEvent()
ts
function createBroadcastEvent<Name, Map>(name, map): object;Defined in: broadcast-event.ts:22
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;channel
Get Signature
ts
get channel(): BroadcastChannel;Returns
BroadcastChannel
id
Get Signature
ts
get id(): `${string}-${string}-${string}-${string}-${string}`;Returns
`${string}-${string}-${string}-${string}-${string}`
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, input): void;Type Parameters
Event
Event extends string
Input
Input extends object
Parameters
name
Event
input
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, "message" | "event">
Returns
ts
(): void;Returns
void