Class EventEmitter

An Event Emitter

Hierarchy

Manager<string, Event>
- EventEmitter

Index

Constructors

constructor

Properties

map

Accessors

Methods

Constructors

constructor

new EventEmitter(): EventEmitter

Overrides Manager<string, Event>.constructor
- Defined in packages/emitter/src/api.ts:46
Returns EventEmitter

Properties

map

map: Map<string, Event>

For backward compatability and performance reasons Manager use Map to store data

Accessors

length

get length(): number

- Defined in packages/manager/src/api.ts:55
An alias for size

Returns number

size

get size(): number

- Defined in packages/manager/src/api.ts:50
Returns the total number of items stored in the Manager

Returns number

Methods

[iterator]

[iterator](): IterableIterator<[string, Event]>

Inherited from Manager.__@iterator@59465
- Defined in packages/manager/src/api.ts:102
Allows for iteration via for..of, learn more: [https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Iterators_and_Generators]

Returns IterableIterator<[string, Event]>

add

add(value: Event): Manager<string, Event>

Inherited from Manager.add
- Defined in packages/manager/src/api.ts:41
Adds a value to Manager, and uses the current size of the Manager as it's key, it works best when all the key in the Manager are numbers

Parameters
- value: Event
Returns Manager<string, Event>

clear

clear(): EventEmitter

Overrides Manager.clear
- Defined in packages/emitter/src/api.ts:231
Clears events and event listeners

Returns EventEmitter

delete

delete(key: string): boolean

Inherited from Manager.delete
- Defined in packages/manager/src/api.ts:66
Removes a value stored in the Manager via a key, returns true if an element in the Map object existed and has been removed, or false if the element does not exist

Parameters
- key: string
Returns boolean

emit

emit(events: string | any[], ...args: any): EventEmitter

- Defined in packages/emitter/src/api.ts:204
Call all listeners within an event

Parameters
- events: string | any[]
- Rest ...args: any
Returns EventEmitter

entries

entries(): IterableIterator<[string, Event]>

Inherited from Manager.entries
- Defined in packages/manager/src/api.ts:88
Returns a new Iterator object that contains an array of [key, value] for each element in the Map object in insertion order.

Returns IterableIterator<[string, Event]>

forEach

forEach(callback: (value?: Event, key?: string, map?: Map<string, Event>) => void, context?: object): Manager<string, Event>

Inherited from Manager.forEach
- Defined in packages/manager/src/api.ts:93
Iterates through the Managers contents, calling a callback function every iteration

Parameters
- callback: (value?: Event, key?: string, map?: Map<string, Event>) => void
  - - (value?: Event, key?: string, map?: Map<string, Event>): void
    - Parameters
      - Optional value: Event
      - Optional key: string
      - Optional map: Map<string, Event>
      Returns void
- Optional context: object
Returns Manager<string, Event>

get

get(key: string): Event

Inherited from Manager.get
- Defined in packages/manager/src/api.ts:20
Get a value stored in the Manager

Parameters
- key: string
Returns Event

getEvent

getEvent(name: string): Event

- Defined in packages/emitter/src/api.ts:51
Gets event, if event doesn't exist create a new one

Parameters
- name: string
Returns Event

getMap

getMap(): Map<string, Event>

Inherited from Manager.getMap
- Defined in packages/manager/src/api.ts:15
Returns the Manager classes base Map

Returns Map<string, Event>

has

has(key: string): boolean

Inherited from Manager.has
- Defined in packages/manager/src/api.ts:83
Checks if the Manager contains a certain key

Parameters
- key: string
Returns boolean

keys

keys(): string[]

Inherited from Manager.keys
- Defined in packages/manager/src/api.ts:25
Returns the keys of all items stored in the Manager as an Array

Returns string[]

last

last(distance?: number): Event

Inherited from Manager.last
- Defined in packages/manager/src/api.ts:60
Returns the last item in the Manager who's index is a certain distance from the last item in the Manager

Parameters
- distance: number = 1
Returns Event

newListener

newListener(name: string, callback: TypeListenerCallback, scope: object): Event

- Defined in packages/emitter/src/api.ts:62
Creates a listener and adds it to an event

Parameters
- name: string
- callback: TypeListenerCallback
- scope: object
Returns Event

off

off(events: TypeEventInput, callback?: object | TypeListenerCallback, scope?: object): EventEmitter

- Defined in packages/emitter/src/api.ts:129
Remove a listener from a given event, or just completely remove an event

Parameters
- events: TypeEventInput
- Optional callback: object | TypeListenerCallback
- Optional scope: object
Returns EventEmitter

on

on(events: TypeEventInput, callback?: object | TypeListenerCallback, scope?: object): EventEmitter

- Defined in packages/emitter/src/api.ts:73
Adds a listener to a given event

Parameters
- events: TypeEventInput
- Optional callback: object | TypeListenerCallback
- Optional scope: object
Returns EventEmitter

once

once(events: TypeEventInput, callback?: object | TypeListenerCallback, scope?: object): EventEmitter

- Defined in packages/emitter/src/api.ts:169
Adds a one time event listener for an event

Parameters
- events: TypeEventInput
- Optional callback: object | TypeListenerCallback
- Optional scope: object
Returns EventEmitter

remove

remove(key: string): Manager<string, Event>

Inherited from Manager.remove
- Defined in packages/manager/src/api.ts:71
Removes a value stored in the Manager via a key, returns the Manager class, allowing for chains

Parameters
- key: string
Returns Manager<string, Event>

removeListener

removeListener(name: string, callback: TypeListenerCallback, scope: object): Event

- Defined in packages/emitter/src/api.ts:109
Removes a listener from an event

Parameters
- name: string
- callback: TypeListenerCallback
- scope: object
Returns Event

set

set(key: string, value: Event): Manager<string, Event>

Inherited from Manager.set
- Defined in packages/manager/src/api.ts:35
Set a value to the Manager using a key

Parameters
- key: string
- value: Event
Returns Manager<string, Event>

values

values(): Event[]

Inherited from Manager.values
- Defined in packages/manager/src/api.ts:30
Returns the values of all items stored in the Manager as an Array

Returns Event[]

Generated using TypeDoc