@stephansama packages / @stephansama/typed-events / events / TypedEvent
Class: TypedEvent<Name, Schema, ForbiddenEvents>
Defined in: events.ts:11
Type Parameters
Name
Name extends string
Schema
Schema extends StandardSchemaV1
ForbiddenEvents
ForbiddenEvents = keyof DocumentEventMap
Constructors
Constructor
ts
new TypedEvent<Name, Schema, ForbiddenEvents>(
name,
schema,
opts): TypedEvent<Name, Schema, ForbiddenEvents>;Defined in: events.ts:35
Parameters
name
Restrict<Name, ForbiddenEvents>
schema
Schema
opts
silenceAsyncWarning?
boolean
target?
EventTarget
Returns
TypedEvent<Name, Schema, ForbiddenEvents>
Properties
name
ts
name: Name;Defined in: events.ts:16
schema
ts
schema: Schema;Defined in: events.ts:17
Accessors
target
Get Signature
ts
get target(): EventTarget;Defined in: events.ts:19
Returns
EventTarget
Set Signature
ts
set target(target): void;Defined in: events.ts:23
Parameters
target
EventTarget
Returns
void
Methods
dispatch()
ts
dispatch(detail): void;Defined in: events.ts:48
Parameters
detail
Detail<Schema>
Returns
void
listen()
ts
listen(callback): () => void;Defined in: events.ts:64
Parameters
callback
(event) => void
Returns
ts
(): void;Returns
void