Class MiniEmitter<T>

Type Parameters

T = any

Hierarchy

MiniEmitter
- BaseObject

Index

Constructors

Properties

Methods

fireUpdate offUpdate onUpdate

Constructors

constructor

new MiniEmitter<T>(): MiniEmitter<T>
Type Parameters
- T = any
Returns MiniEmitter<T>
- Defined in core/src/utils/MiniEmitter.ts:8

Properties

`Private` _callbacks

_callbacks: MiniEmitterCallback<T>[] = []

Methods

fireUpdate

fireUpdate(updated?: T[]): void
Runs all of the callbacks for this emitter. (meant to run when an update occurs)
Parameters
- Optional updated: T[]
  
  The objects that caused this update.
Returns void
- Defined in core/src/utils/MiniEmitter.ts:33

offUpdate

offUpdate(callback: MiniEmitterCallback<T>): MiniEmitter<T>
Stops listening for Map updates.

Returns
this, useful for chaining.
Parameters
- callback: MiniEmitterCallback<T>
  
  The callback to stop listening for updates on.
Returns MiniEmitter<T>
- Defined in core/src/utils/MiniEmitter.ts:24

onUpdate

onUpdate(callback: MiniEmitterCallback<T>): MiniEmitter<T>
Listen for an update to this Map.

Returns
this, useful for chaining.
Parameters
- callback: MiniEmitterCallback<T>
  
  The callback to run when an update occurs.
Returns MiniEmitter<T>
- Defined in core/src/utils/MiniEmitter.ts:15