@stephansama packages / @stephansama/typed-events / event / createEvent

Function: createEvent()

function createEvent<Name, Schema>(
   name, 
   schema, 
   opts): object;

Defined in: event.ts:20

Type Parameters

Name

Name extends string

Schema

Schema extends StandardSchemaV1<unknown, unknown>

Parameters

name

Name

schema

Schema

opts

silenceAsyncWarning?

boolean

target?

EventTarget

Returns

object

name

name: Name;

schema

schema: Schema;

target

Get Signature

get target(): EventTarget;

Returns

EventTarget

Set Signature

set target(target): void;

Parameters

target

EventTarget

Returns

void

dispatch()

dispatch(detail): void;

Parameters

detail

object & InferInput<Schema>

Returns

void

listen()

listen(callback): () => void;

Parameters

callback

ListenerCallback<object & InferInput<Schema>, "event">

Returns

(): void;

Returns

void