Class: Client

Extends

• EventEmitter

Constructors

Constructor

new Client(options?): Client

Parameters

Parameter	Type
options	ClientOptions

Returns

Client

Overrides

EventEmitter.constructor

Properties

channels

channels: ChannelManager

---

emojis

emojis: EmojiManager

---

gateway

gateway: GatewayManager

---

options

options: ClientOptions

---

rest

rest: RESTManager

---

servers

servers: ServerManager

---

sweepers

sweepers: SweeperManager

---

user

user: ClientUser | null = null

---

users

users: UserManager

---

voice

readonly voice: VoiceManager

Methods

emit()

emit<K>(event, ...args): boolean

Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

Returns true if the event had listeners, false otherwise.

import { EventEmitter } from 'node:events';
const myEmitter = new EventEmitter();

// First listener
myEmitter.on('event', function firstListener() {
  console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
  console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
  const parameters = args.join(', ');
  console.log(`event with parameters ${parameters} in third listener`);
});

console.log(myEmitter.listeners('event'));

myEmitter.emit('event', 1, 2, 3, 4, 5);

// Prints:
// [
//   [Function: firstListener],
//   [Function: secondListener],
//   [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener

Type Parameters

Type Parameter
K extends keyof ClientEvents

Parameters

Parameter	Type
event	K
...args	ClientEvents[K]

Returns

boolean

Since

v0.1.26

Overrides

EventEmitter.emit

---

login()

login(token): Promise<any>

Connects the bot to the Stoat Gateway

Parameters

Parameter	Type
token	string

Returns

Promise<any>

---

on()

on<K>(event, listener): this

Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

server.on('connection', (stream) => {
  console.log('someone connected!');
});

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

By default, event listeners are invoked in the order they are added. The emitter.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a

Type Parameters

Type Parameter
K extends keyof ClientEvents

Parameters

Parameter	Type	Description
event	K	-
listener	(...args) => void	The callback function

Returns

this

Since

v0.1.101

Overrides

EventEmitter.on

---

once()

once<K>(event, listener): this

Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

server.once('connection', (stream) => {
  console.log('Ah, we have our first user!');
});

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

By default, event listeners are invoked in the order they are added. The emitter.prependOnceListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a

Type Parameters

Type Parameter
K extends keyof ClientEvents

Parameters

Parameter	Type	Description
event	K	-
listener	(...args) => void	The callback function

Returns

this

Since

v0.3.0

Overrides

EventEmitter.once