Class KeyedEventWrapper<T>

Simple implementation of a key-based event class.

Type Parameters

T extends unknown[]

Index

Constructors

Methods

add addAny getWrapper remove removeAny trigger

Constructors

constructor

new KeyedEventWrapper<T extends unknown[]>(): KeyedEventWrapper<T>
Type Parameters
- T extends unknown[]
Returns KeyedEventWrapper<T>

Methods

add

add(key: string, callback: (...args: T) => void): (...args: T) => void
Add a callback function tied to the given key. The callback function will be executed when this KeyedEventWrapper is triggered using the same key.
Parameters
- key: string
  Key
- callback: (...args: T) => void
  Callback function to execute
Returns (...args: T) => void
The callback passed in, can be used with remove()

addAny

addAny(
callback: (key: string, ...args: T) => void,
): (key: string, ...args: T) => void
Add a callback function that will be executed any time a trigger occurs. The first argument for the callback function is the key, the rest of the arguments are what get passed to the trigger.
Parameters
- callback: (key: string, ...args: T) => void
  Callback function to execute
Returns (key: string, ...args: T) => void
The callback passed in, can be used with removeAny()

getWrapper

getWrapper(key: string, createIfMissing?: boolean): EventWrapper<T>
Return an EventWrapper for the given key. The EventWrapper holds all callbacks added with the same key, and is triggered when trigger is called with the same key.
Parameters
- key: string
  Key
- OptionalcreateIfMissing: boolean
  If the wrapper is missing, a new one will be created.
Returns EventWrapper<T>
The EventWrapper for the given key, or null if not found.

remove

remove(key: string, callback: (...args: T) => void): void
Remove a callback function tied to the given key.
Parameters
- key: string
  Key that was used to add the callback function
- callback: (...args: T) => void
  Callback function to remove
Returns void

removeAny

removeAny(callback: (key: string, ...args: T) => void): void
Remove a callback function that was added using addAny().
Parameters
- callback: (key: string, ...args: T) => void
  Callback function to remove
Returns void

trigger

trigger(key: string, ...args: T): void
Trigger all callback functions that were added using the same key. All arguments after key will be passed to the callback functions.
Parameters
- key: string
  Key of the events to trigger
- ...args: T
  Arguments to pass to callbacks
Returns void