Skip to content

TypedMessage

Defined in: message.ts:5

Extends

Section titled “Extends”
  • ValidatorMap<Name, Map, "message", { origin: string; window: Window; }>

Type Parameters

Section titled “Type Parameters”

Name

Section titled “Name”

Name extends string

Map

Section titled “Map”

Map extends Record<string, StandardSchemaV1>

Properties

Section titled “Properties”

map

Section titled “map”
map: Map;

Defined in: utils/types.ts:58

Inherited from

Section titled “Inherited from”

ValidatorMap.map

name

Section titled “name”
name: Name;

Defined in: utils/types.ts:59

Inherited from

Section titled “Inherited from”

ValidatorMap.name

window

Section titled “window”
window: Window;

Defined in: message.ts:14

Methods

Section titled “Methods”

dispatch()

Section titled “dispatch()”
dispatch<Event, Input>(
   name,
   input,
   options?): void;

Defined in: utils/types.ts:41

Type Parameters

Section titled “Type Parameters”
Event
Section titled “Event”

Event extends string

Input
Section titled “Input”

Input extends object

Parameters

Section titled “Parameters”
name
Section titled “name”

Event

input
Section titled “input”

Input

options?
Section titled “options?”
origin
Section titled “origin”

string

window
Section titled “window”

Window

Returns

Section titled “Returns”

void

Inherited from

Section titled “Inherited from”

ValidatorMap.dispatch

listen()

Section titled “listen()”
listen<Event, Input>(name, callback): () => void;

Defined in: utils/types.ts:50

Type Parameters

Section titled “Type Parameters”
Event
Section titled “Event”

Event extends string

Input
Section titled “Input”

Input extends object

Parameters

Section titled “Parameters”
name
Section titled “name”

Event

callback
Section titled “callback”

ListenerCallback<Input, "message">

Returns

Section titled “Returns”

() => void

Inherited from

Section titled “Inherited from”

ValidatorMap.listen