EventDispatcher

Documentation / editor/util/EventDispatcher

EventDispatcher<T>

Defined in: editor/util/EventDispatcher.ts:6

Extended by

• Editor

Type Parameters

Type Parameter	Default type
T extends Record<string, any>	Record<string, Event>

Constructors

Constructor

new EventDispatcher<T>(): EventDispatcher<T>;

Returns

EventDispatcher<T>

Methods

addEventListener()

Call Signature

addEventListener<K>(
   type: K, 
   listener: (event: T[K]) => any, 
   options?: AddEventListenerOptions): void;

Defined in: editor/util/EventDispatcher.ts:19

Type Parameters

Type Parameter
K extends string | number | symbol

Parameters

Parameter	Type
type	K
listener	(event: T[K]) => any
options?	AddEventListenerOptions

Returns

void

Call Signature

addEventListener(
   type: string, 
   listener: (event: Event) => any, 
   options?: AddEventListenerOptions): void;

Defined in: editor/util/EventDispatcher.ts:20

Parameters

Parameter	Type
type	string
listener	(event: Event) => any
options?	AddEventListenerOptions

Returns

void

dispatchEvent()

dispatchEvent(event: Event, catchErrors?: boolean): void;

Defined in: editor/util/EventDispatcher.ts:39

Parameters

Parameter	Type
event	Event
catchErrors?	boolean

Returns

void

off()

Call Signature

off<K>(
   type: K, 
   listener: (event: T[K]) => any, 
   options?: AddEventListenerOptions): void;

Defined in: editor/util/EventDispatcher.ts:13

Type Parameters

Type Parameter
K extends string | number | symbol

Parameters

Parameter	Type
type	K
listener	(event: T[K]) => any
options?	AddEventListenerOptions

Returns

void

Call Signature

off(
   type: string, 
   listener: (event: Event) => any, 
   options?: AddEventListenerOptions): void;

Defined in: editor/util/EventDispatcher.ts:14

Parameters

Parameter	Type
type	string
listener	(event: Event) => any
options?	AddEventListenerOptions

Returns

void

on()

Call Signature

on<K>(
   type: K, 
   listener: (event: T[K]) => any, 
   options?: AddEventListenerOptions): void;

Defined in: editor/util/EventDispatcher.ts:7

Type Parameters

Type Parameter
K extends string | number | symbol

Parameters

Parameter	Type
type	K
listener	(event: T[K]) => any
options?	AddEventListenerOptions

Returns

void

Call Signature

on(
   type: string, 
   listener: (event: Event) => any, 
   options?: AddEventListenerOptions): void;

Defined in: editor/util/EventDispatcher.ts:8

Parameters

Parameter	Type
type	string
listener	(event: Event) => any
options?	AddEventListenerOptions

Returns

void

removeEventListener()

Call Signature

removeEventListener<K>(
   type: K, 
   listener: (event: T[K]) => any, 
   options?: AddEventListenerOptions): void;

Defined in: editor/util/EventDispatcher.ts:26

Type Parameters

Type Parameter
K extends string | number | symbol

Parameters

Parameter	Type
type	K
listener	(event: T[K]) => any
options?	AddEventListenerOptions

Returns

void

Call Signature

removeEventListener(
   type: string, 
   listener: (event: Event) => any, 
   options?: AddEventListenerOptions): void;

Defined in: editor/util/EventDispatcher.ts:31

Parameters

Parameter	Type
type	string
listener	(event: Event) => any
options?	AddEventListenerOptions

Returns

void