Class Client<E>

The primary class for interfacing with Discord. See Client Events for a list of events.

Type Parameters

Hierarchy

Constructors

Properties

channelGuildMap: Record<string, string>
gatewayURL: string
groupChannels: TypedCollection<string, RawGroupChannel, GroupChannel, []>
guildShardMap: Record<string, number>
guilds: TypedCollection<string, RawGuild, Guild, []>
privateChannels: TypedCollection<string, RawPrivateChannel, PrivateChannel, []>
ready: boolean
shards: ShardManager
startTime: number = 0
threadGuildMap: Record<string, string>
unavailableGuilds: TypedCollection<string, RawUnavailableGuild, UnavailableGuild, []>
users: TypedCollection<string, RawUser, User, []>
util: Util
voiceAdapters: Map<string, DiscordGatewayAdapterLibraryMethods>
captureRejectionSymbol: typeof captureRejectionSymbol
captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

defaultMaxListeners: number
errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Accessors

  • get voiceConnections(): Map<string, VoiceConnection>
  • The active voice connections of this client.

    Returns Map<string, VoiceConnection>

Methods

  • Type Parameters

    • K extends string | number | symbol

    Parameters

    • event: K
    • listener: ((...args: E[K]) => void)
        • (...args: E[K]): void
        • Parameters

          • Rest ...args: E[K]

          Returns void

    Returns Client<E>

  • Connect the client to Discord.

    Returns Promise<void>

  • Type Parameters

    • K extends string | number | symbol

    Parameters

    • eventName: K
    • Rest ...args: E[K]

    Returns boolean

  • Type Parameters

    • K extends string | number | symbol

    Parameters

    • eventName: K
    • Rest ...args: E[K]

    Returns boolean

  • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

    const EventEmitter = require('events');
    const myEE = new EventEmitter();
    myEE.on('foo', () => {});
    myEE.on('bar', () => {});

    const sym = Symbol('symbol');
    myEE.on(sym, () => {});

    console.log(myEE.eventNames());
    // Prints: [ 'foo', 'bar', Symbol(symbol) ]

    Since

    v6.0.0

    Returns (string | symbol)[]

  • Get a channel from an ID. This will return undefined if the channel is not cached.

    Type Parameters

    Parameters

    • channelID: string

      The id of the channel.

    Returns undefined | T

  • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    Since

    v1.0.0

    Returns number

  • Get a voice connection.

    Parameters

    • guildID: string

      The ID of the guild the voice channel belongs to.

    Returns undefined | VoiceConnection

  • Leave a voice channel.

    Parameters

    • guildID: string

      The ID of the guild the voice channel belongs to.

    Returns void

  • Type Parameters

    • K extends string | number | symbol

    Parameters

    • event: K
    • listener: ((...args: E[K]) => void)
        • (...args: E[K]): void
        • Parameters

          • Rest ...args: E[K]

          Returns void

    Returns Client<E>

  • Type Parameters

    • K extends string | number | symbol

    Parameters

    • event: K
    • listener: ((...args: E[K]) => void)
        • (...args: E[K]): void
        • Parameters

          • Rest ...args: E[K]

          Returns void

    Returns Client<E>

  • Type Parameters

    • K extends string | number | symbol

    Parameters

    • event: K
    • listener: ((...args: E[K]) => void)
        • (...args: E[K]): void
        • Parameters

          • Rest ...args: E[K]

          Returns void

    Returns Client<E>

  • Type Parameters

    • K extends string | number | symbol

    Parameters

    • event: K
    • listener: ((...args: E[K]) => void)
        • (...args: E[K]): void
        • Parameters

          • Rest ...args: E[K]

          Returns void

    Returns Client<E>

  • Type Parameters

    • K extends string | number | symbol

    Parameters

    • event: K
    • listener: ((...args: E[K]) => void)
        • (...args: E[K]): void
        • Parameters

          • Rest ...args: E[K]

          Returns void

    Returns Client<E>

  • Type Parameters

    • K extends string | number | symbol

    Parameters

    • event: K
    • listener: ((...args: E[K]) => void)
        • (...args: E[K]): void
        • Parameters

          • Rest ...args: E[K]

          Returns void

    Returns Client<E>

  • 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 Client<E>

  • Returns a copy of the array of listeners for the event named eventName.

    For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

    For EventTargets this is the only way to get the event listeners for the event target. This is useful for debugging and diagnostic purposes.

    const { getEventListeners, EventEmitter } = require('events');

    {
    const ee = new EventEmitter();
    const listener = () => console.log('Events are fun');
    ee.on('foo', listener);
    getEventListeners(ee, 'foo'); // [listener]
    }
    {
    const et = new EventTarget();
    const listener = () => console.log('Events are fun');
    et.addEventListener('foo', listener);
    getEventListeners(et, 'foo'); // [listener]
    }

    Since

    v15.2.0, v14.17.0

    Parameters

    • emitter: EventEmitter | _DOMEventTarget
    • name: string | symbol

    Returns Function[]

  • A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

    const { EventEmitter, listenerCount } = require('events');
    const myEmitter = new EventEmitter();
    myEmitter.on('event', () => {});
    myEmitter.on('event', () => {});
    console.log(listenerCount(myEmitter, 'event'));
    // Prints: 2

    Since

    v0.9.12

    Deprecated

    Since v3.2.0 - Use listenerCount instead.

    Parameters

    • emitter: EventEmitter

      The emitter to query

    • eventName: string | symbol

      The event name

    Returns number

  • const { on, EventEmitter } = require('events');

    (async () => {
    const ee = new EventEmitter();

    // Emit later on
    process.nextTick(() => {
    ee.emit('foo', 'bar');
    ee.emit('foo', 42);
    });

    for await (const event of on(ee, 'foo')) {
    // The execution of this inner block is synchronous and it
    // processes one event at a time (even with await). Do not use
    // if concurrent execution is required.
    console.log(event); // prints ['bar'] [42]
    }
    // Unreachable here
    })();

    Returns an AsyncIterator that iterates eventName events. It will throw if the EventEmitter emits 'error'. It removes all listeners when exiting the loop. The value returned by each iteration is an array composed of the emitted event arguments.

    An AbortSignal can be used to cancel waiting on events:

    const { on, EventEmitter } = require('events');
    const ac = new AbortController();

    (async () => {
    const ee = new EventEmitter();

    // Emit later on
    process.nextTick(() => {
    ee.emit('foo', 'bar');
    ee.emit('foo', 42);
    });

    for await (const event of on(ee, 'foo', { signal: ac.signal })) {
    // The execution of this inner block is synchronous and it
    // processes one event at a time (even with await). Do not use
    // if concurrent execution is required.
    console.log(event); // prints ['bar'] [42]
    }
    // Unreachable here
    })();

    process.nextTick(() => ac.abort());

    Since

    v13.6.0, v12.16.0

    Returns

    that iterates eventName events emitted by the emitter

    Parameters

    • emitter: EventEmitter
    • eventName: string

      The name of the event being listened for

    • Optional options: StaticEventEmitterOptions

    Returns AsyncIterableIterator<any>

  • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

    This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event semantics and does not listen to the 'error' event.

    const { once, EventEmitter } = require('events');

    async function run() {
    const ee = new EventEmitter();

    process.nextTick(() => {
    ee.emit('myevent', 42);
    });

    const [value] = await once(ee, 'myevent');
    console.log(value);

    const err = new Error('kaboom');
    process.nextTick(() => {
    ee.emit('error', err);
    });

    try {
    await once(ee, 'myevent');
    } catch (err) {
    console.log('error happened', err);
    }
    }

    run();

    The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the 'error' event itself, then it is treated as any other kind of event without special handling:

    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();

    once(ee, 'error')
    .then(([err]) => console.log('ok', err.message))
    .catch((err) => console.log('error', err.message));

    ee.emit('error', new Error('boom'));

    // Prints: ok boom

    An AbortSignal can be used to cancel waiting for the event:

    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();
    const ac = new AbortController();

    async function foo(emitter, event, signal) {
    try {
    await once(emitter, event, { signal });
    console.log('event emitted!');
    } catch (error) {
    if (error.name === 'AbortError') {
    console.error('Waiting for the event was canceled!');
    } else {
    console.error('There was an error', error.message);
    }
    }
    }

    foo(ee, 'foo', ac.signal);
    ac.abort(); // Abort waiting for the event
    ee.emit('foo'); // Prints: Waiting for the event was canceled!

    Since

    v11.13.0, v10.16.0

    Parameters

    • emitter: _NodeEventTarget
    • eventName: string | symbol
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

  • Parameters

    • emitter: _DOMEventTarget
    • eventName: string
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

  • const {
    setMaxListeners,
    EventEmitter
    } = require('events');

    const target = new EventTarget();
    const emitter = new EventEmitter();

    setMaxListeners(5, target, emitter);

    Since

    v15.4.0

    Parameters

    • Optional n: number

      A non-negative number. The maximum number of listeners per EventTarget event.

    • Rest ...eventTargets: (EventEmitter | _DOMEventTarget)[]

    Returns void