Welshman

Appearance

Welshman Docs / @welshman/lib / Emitter

Class: Emitter ​

Defined in: packages/lib/src/Emitter.ts:6

Extended EventEmitter that also emits all events to '*' listeners

Extends ​

  • EventEmitter

Extended by ​

Constructors ​

Constructor ​

new Emitter(): Emitter

Returns ​

Emitter

Inherited from ​

EventEmitter.constructor

Properties ​

defaultMaxListeners ​

static defaultMaxListeners: number

Defined in: node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:5

Inherited from ​

EventEmitter.defaultMaxListeners

Methods ​

addListener() ​

addListener(type, listener): this

Defined in: node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:11

Parameters ​

type ​

string | number

listener ​

Listener

Returns ​

this

Inherited from ​

EventEmitter.addListener

emit() ​

emit(type, ...args): boolean

Defined in: packages/lib/src/Emitter.ts:13

Emits an event to listeners and to '*' listeners

Parameters ​

type ​

string

Event type/name

args ​

...any[]

Arguments to pass to listeners

Returns ​

boolean

True if event had listeners

Overrides ​

EventEmitter.emit

eventNames() ​

eventNames(): (string | number)[]

Defined in: node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:7

Returns ​

(string | number)[]

Inherited from ​

EventEmitter.eventNames

getMaxListeners() ​

getMaxListeners(): number

Defined in: node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:9

Returns ​

number

Inherited from ​

EventEmitter.getMaxListeners

listenerCount() ​

listenerCount(type): number

Defined in: node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:20

Parameters ​

type ​

string | number

Returns ​

number

Inherited from ​

EventEmitter.listenerCount

listeners() ​

listeners(type): Listener[]

Defined in: node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:19

Parameters ​

type ​

string | number

Returns ​

Listener[]

Inherited from ​

EventEmitter.listeners

off() ​

off(type, listener): this

Defined in: node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:17

Parameters ​

type ​

string | number

listener ​

Listener

Returns ​

this

Inherited from ​

EventEmitter.off

on() ​

on(type, listener): this

Defined in: node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:12

Parameters ​

type ​

string | number

listener ​

Listener

Returns ​

this

Inherited from ​

EventEmitter.on

once() ​

once(type, listener): this

Defined in: node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:13

Parameters ​

type ​

string | number

listener ​

Listener

Returns ​

this

Inherited from ​

EventEmitter.once

prependListener() ​

prependListener(type, listener): this

Defined in: node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:14

Parameters ​

type ​

string | number

listener ​

Listener

Returns ​

this

Inherited from ​

EventEmitter.prependListener

prependOnceListener() ​

prependOnceListener(type, listener): this

Defined in: node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:15

Parameters ​

type ​

string | number

listener ​

Listener

Returns ​

this

Inherited from ​

EventEmitter.prependOnceListener

rawListeners() ​

rawListeners(type): Listener[]

Defined in: node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:21

Parameters ​

type ​

string | number

Returns ​

Listener[]

Inherited from ​

EventEmitter.rawListeners

removeAllListeners() ​

removeAllListeners(type?): this

Defined in: node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:18

Parameters ​

type? ​

string | number

Returns ​

this

Inherited from ​

EventEmitter.removeAllListeners

removeListener() ​

removeListener(type, listener): this

Defined in: node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:16

Parameters ​

type ​

string | number

listener ​

Listener

Returns ​

this

Inherited from ​

EventEmitter.removeListener

setMaxListeners() ​

setMaxListeners(n): this

Defined in: node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:8

Parameters ​

n ​

number

Returns ​

this

Inherited from ​

EventEmitter.setMaxListeners

listenerCount() ​

static listenerCount(emitter, type): number

Defined in: node_modules/.pnpm/@types+events@3.0.3/node_modules/@types/events/index.d.ts:4

Parameters ​

emitter ​

EventEmitter

type ​

string | number

Returns ​

number

Inherited from ​

EventEmitter.listenerCount