Documentation
Classes
discord-player
PlayerEventsEmitter

PlayerEventsEmitter extends EventEmitter<L>

new PlayerEventsEmitter(requiredEvents)
ParameterTypeOptionalDescription
requiredEventsArray<keyof L>-

Properties

public requiredEvents: Array<keyof L>

public static defaultMaxListeners: number

  • Source: packages/utils/dist/index.d.ts#L42

Methods

public addListener(event, listener): PlayerEventsEmitter<L>

ParameterTypeOptionalDescription
eventU-
listenerL[U]-
  • Source: packages/utils/dist/index.d.ts#L44

public emit(name, args): boolean

ParameterTypeOptionalDescription
nameK-
argsParameters<L[K]>-

public eventNames(): Array<U>

  • Source: packages/utils/dist/index.d.ts#L53

public getMaxListeners(): number

  • Source: packages/utils/dist/index.d.ts#L57

public listenerCount(type): number

ParameterTypeOptionalDescription
typekeyof L-
  • Source: packages/utils/dist/index.d.ts#L54

public listeners(type): Array<L[U]>

ParameterTypeOptionalDescription
typeU-
  • Source: packages/utils/dist/index.d.ts#L55

public off(event, listener): PlayerEventsEmitter<L>

ParameterTypeOptionalDescription
eventU-
listenerL[U]-
  • Source: packages/utils/dist/index.d.ts#L51

public on(event, listener): PlayerEventsEmitter<L>

ParameterTypeOptionalDescription
eventU-
listenerL[U]-
  • Source: packages/utils/dist/index.d.ts#L50

public once(event, listener): PlayerEventsEmitter<L>

ParameterTypeOptionalDescription
eventU-
listenerL[U]-
  • Source: packages/utils/dist/index.d.ts#L49

public prependListener(event, listener): PlayerEventsEmitter<L>

ParameterTypeOptionalDescription
eventU-
listenerL[U]-
  • Source: packages/utils/dist/index.d.ts#L45

public prependOnceListener(event, listener): PlayerEventsEmitter<L>

ParameterTypeOptionalDescription
eventU-
listenerL[U]-
  • Source: packages/utils/dist/index.d.ts#L46

public rawListeners(type): Array<L[U]>

ParameterTypeOptionalDescription
typeU-
  • Source: packages/utils/dist/index.d.ts#L56

public removeAllListeners(event?): PlayerEventsEmitter<L>

ParameterTypeOptionalDescription
eventkeyof L-
  • Source: packages/utils/dist/index.d.ts#L48

public removeListener(event, listener): PlayerEventsEmitter<L>

ParameterTypeOptionalDescription
eventU-
listenerL[U]-
  • Source: packages/utils/dist/index.d.ts#L47

public setMaxListeners(n): PlayerEventsEmitter<L>

ParameterTypeOptionalDescription
nnumber-
  • Source: packages/utils/dist/index.d.ts#L58