_BaseTypedEventEmitter | @jonahsnider/util

Typed event emitter with no built in events.

internal

Type Parameters

T extends EventListeners

Hierarchy

EventEmitter
- _BaseTypedEventEmitter
  - TypedEventEmitter

Index

Methods

addListener

addListener<E>(eventName: E, listener: T[E]): _BaseTypedEventEmitter<T>

Overrides EventEmitter.addListener
- Defined in src/typed-event-emitter.ts:38
Type Parameters
- E extends string | number | symbol
Parameters
- eventName: E
- listener: T[E]
Returns _BaseTypedEventEmitter<T>

emit

emit<E>(eventName: E, ...args: Parameters<T[E]>): boolean

Overrides EventEmitter.emit
- Defined in src/typed-event-emitter.ts:39
Type Parameters
- E extends string | number | symbol
Parameters
- eventName: E
- Rest ...args: Parameters<T[E]>
Returns boolean

eventNames

eventNames(): Exclude<keyof T, number>[]

Overrides EventEmitter.eventNames
- Defined in src/typed-event-emitter.ts:40
Returns Exclude<keyof T, number>[]

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:471
Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to {@link defaultMaxListeners}.

since
v1.0.0

Returns number

listenerCount

listenerCount(eventName: keyof T): number

Overrides EventEmitter.listenerCount
- Defined in src/typed-event-emitter.ts:41
Parameters
- eventName: keyof T
Returns number

listeners

listeners<E>(eventName: E): T[E][]

Overrides EventEmitter.listeners
- Defined in src/typed-event-emitter.ts:42
Type Parameters
- E extends string | number | symbol
Parameters
- eventName: E
Returns T[E][]

off

off<E>(eventName: E, listener: T[E]): _BaseTypedEventEmitter<T>

Overrides EventEmitter.off
- Defined in src/typed-event-emitter.ts:43
Type Parameters
- E extends string | number | symbol
Parameters
- eventName: E
- listener: T[E]
Returns _BaseTypedEventEmitter<T>

on

on<E>(eventName: E, listener: T[E]): _BaseTypedEventEmitter<T>

Overrides EventEmitter.on
- Defined in src/typed-event-emitter.ts:44
Type Parameters
- E extends string | number | symbol
Parameters
- eventName: E
- listener: T[E]
Returns _BaseTypedEventEmitter<T>

once

once<E>(eventName: E, listener: T[E]): _BaseTypedEventEmitter<T>

Overrides EventEmitter.once
- Defined in src/typed-event-emitter.ts:45
Type Parameters
- E extends string | number | symbol
Parameters
- eventName: E
- listener: T[E]
Returns _BaseTypedEventEmitter<T>

prependListener

prependListener<E>(eventName: E, listener: T[E]): _BaseTypedEventEmitter<T>

Overrides EventEmitter.prependListener
- Defined in src/typed-event-emitter.ts:46
Type Parameters
- E extends string | number | symbol
Parameters
- eventName: E
- listener: T[E]
Returns _BaseTypedEventEmitter<T>

prependOnceListener

prependOnceListener<E>(eventName: E, listener: T[E]): _BaseTypedEventEmitter<T>

Overrides EventEmitter.prependOnceListener
- Defined in src/typed-event-emitter.ts:47
Type Parameters
- E extends string | number | symbol
Parameters
- eventName: E
- listener: T[E]
Returns _BaseTypedEventEmitter<T>

rawListeners

rawListeners<E>(eventName: E): T[E][]

Overrides EventEmitter.rawListeners
- Defined in src/typed-event-emitter.ts:50
Type Parameters
- E extends string | number | symbol
Parameters
- eventName: E
Returns T[E][]

removeAllListeners

removeAllListeners(eventName?: keyof T): _BaseTypedEventEmitter<T>

Overrides EventEmitter.removeAllListeners
- Defined in src/typed-event-emitter.ts:48
Parameters
- Optional eventName: keyof T
Returns _BaseTypedEventEmitter<T>

removeListener

removeListener<E>(eventName: E, listener: T[E]): _BaseTypedEventEmitter<T>

Overrides EventEmitter.removeListener
- Defined in src/typed-event-emitter.ts:49
Type Parameters
- E extends string | number | symbol
Parameters
- eventName: E
- listener: T[E]
Returns _BaseTypedEventEmitter<T>

setMaxListeners

setMaxListeners(n: number): _BaseTypedEventEmitter<T>

Inherited from EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:465
By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

Returns a reference to the EventEmitter, so that calls can be chained.

since
v0.3.5

Parameters
- n: number
Returns _BaseTypedEventEmitter<T>

Type Parameters

T extends EventListeners

Hierarchy

Index

Methods

Methods

addListener

Type Parameters

E extends string | number | symbol

Parameters

eventName: E

listener: T[E]

Returns _BaseTypedEventEmitter<T>

emit

Type Parameters

E extends string | number | symbol

Parameters

eventName: E

Rest ...args: Parameters<T[E]>

Returns boolean

eventNames

Returns Exclude<keyof T, number>[]

getMaxListeners

Returns number

listenerCount

Parameters

eventName: keyof T

Returns number

listeners

Type Parameters

E extends string | number | symbol

Parameters

eventName: E

Returns T[E][]

off

Type Parameters

E extends string | number | symbol

Parameters

eventName: E

listener: T[E]

Returns _BaseTypedEventEmitter<T>

on

Type Parameters

E extends string | number | symbol

Parameters

eventName: E

listener: T[E]

Returns _BaseTypedEventEmitter<T>

once

Type Parameters

E extends string | number | symbol

Parameters

eventName: E

listener: T[E]

Returns _BaseTypedEventEmitter<T>

prependListener

Type Parameters

E extends string | number | symbol

Parameters

eventName: E

listener: T[E]

Returns _BaseTypedEventEmitter<T>

prependOnceListener

Type Parameters

E extends string | number | symbol

Parameters

eventName: E

listener: T[E]

Returns _BaseTypedEventEmitter<T>

rawListeners

Type Parameters

E extends string | number | symbol

Parameters

eventName: E

Returns T[E][]

removeAllListeners

Parameters

Optional eventName: keyof T

Returns _BaseTypedEventEmitter<T>

removeListener