Class EventDispatcher

Event Dispatcher

Export

EventDispatcher

Date

2023.12.26

Author

yisky

Hierarchy (view full)

EventDispatcher

Index

Constructors

Methods

dispose emit off on once

Constructors

constructor

new EventDispatcher(): EventDispatcher
Returns EventDispatcher

Methods

dispose

dispose(): void
Clear subscribers

Returns void
Memberof
EventDispatcher

emit

emit(event): void
Emit event
Parameters
- event: {
  type: string;
  [key: string]: any;
  }
  - [key: string]: any
  - type: string
Returns void
Memberof
EventDispatcher

off

off(type, callback?): void
Unsubscribe a event, if the callback param is not defined, all subscribers of this type will be removed.
Parameters
- type: string
- Optionalcallback: SubscriberCallbackFn
  subscriber callback
Returns void
Memberof
EventDispatcher

on

on(type, callback, options?): void
Subscribe a event
Parameters
- type: string
  event type
- callback: SubscriberCallbackFn
  callback functions
- Optionaloptions: {
  priority?: Priority;
  target?: any;
  } = {}
  options
  - Optionalpriority?: Priority
  - Optionaltarget?: any
Returns void
Memberof
EventDispatcher

once

once(type, callback, options?): void
Subscribe a event, just emit once
Parameters
- type: string
- callback: SubscriberCallbackFn
  subscriber callback
- options: {
  priority?: Priority;
  target?: any;
  } = {}
  - Optionalpriority?: Priority
  - Optionaltarget?: any
Returns void
Memberof
EventDispatcher