Skip to main content

Class: BakitClient<Ready>

Defined in: packages/bakit/src/BakitClient.ts:13

Extends​

  • Client<Ready>

Type Parameters​

Ready​

Ready extends boolean = boolean

Constructors​

Constructor​

new BakitClient<Ready>(options): BakitClient<Ready>

Defined in: packages/bakit/src/BakitClient.ts:19

Parameters​

options​

ClientOptions

Returns​

BakitClient<Ready>

Overrides​

Client<Ready>.constructor

Properties​

managers​

managers: object

Defined in: packages/bakit/src/BakitClient.ts:14

commands​

commands: CommandManager

listeners​

listeners: ListenerManager

Methods​

[custom]()​

[custom](): string

Defined in: packages/bakit/src/BakitClient.ts:75

Override BakitClient output when using logger for security concern.

Returns​

string

BakitClient {}

emit()​

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

Defined in: packages/bakit/src/BakitClient.ts:67

Type Parameters​

K​

K extends keyof BakitClientEvents

Parameters​

event​

K

args​

...BakitClientEvents[K]

Returns​

boolean

Overrides​

Client.emit

isReady()​

isReady(): this is BakitClient<true>

Defined in: packages/bakit/src/BakitClient.ts:31

Check if the client is connected to gateway successfully and finished initialization.

Returns​

this is BakitClient<true>

Overrides​

Client.isReady

off()​

off<K>(event, listener): this

Defined in: packages/bakit/src/BakitClient.ts:49

Type Parameters​

K​

K extends keyof BakitClientEvents

Parameters​

event​

K

listener​

(...args) => void

Returns​

this

Overrides​

Client.off

on()​

on<K>(event, listener): this

Defined in: packages/bakit/src/BakitClient.ts:35

Type Parameters​

K​

K extends keyof BakitClientEvents

Parameters​

event​

K

listener​

(...args) => void

Returns​

this

Overrides​

Client.on

once()​

once<K>(event, listener): this

Defined in: packages/bakit/src/BakitClient.ts:42

Type Parameters​

K​

K extends keyof BakitClientEvents

Parameters​

event​

K

listener​

(...args) => void

Returns​

this

Overrides​

Client.once

removeAllListeners()​

removeAllListeners(event?): this

Defined in: packages/bakit/src/BakitClient.ts:56

Parameters​

event?​

keyof BakitClientEvents

Returns​

this

Overrides​

Client.removeAllListeners

removeListener()​

removeListener<K>(event, listener): this

Defined in: packages/bakit/src/BakitClient.ts:60

Removes the specified listener from the listener array for the event named eventName.

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

removeListener() will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener() must be called multiple times to remove each instance.

Once an event is emitted, all listeners attached to it at the time of emitting are called in order. This implies that any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution will not remove them fromemit() in progress. Subsequent events behave as expected.

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

const callbackA = () => {
  console.log('A');
  myEmitter.removeListener('event', callbackB);
};

const callbackB = () => {
  console.log('B');
};

myEmitter.on('event', callbackA);

myEmitter.on('event', callbackB);

// callbackA removes listener callbackB but it will still be called.
// Internal listener array at time of emit [callbackA, callbackB]
myEmitter.emit('event');
// Prints:
//   A
//   B

// callbackB is now removed.
// Internal listener array [callbackA]
myEmitter.emit('event');
// Prints:
//   A

Because listeners are managed using an internal array, calling this will change the position indices of any listener registered after the listener being removed. This will not impact the order in which listeners are called, but it means that any copies of the listener array as returned by the emitter.listeners() method will need to be recreated.

When a single function has been added as a handler multiple times for a single event (as in the example below), removeListener() will remove the most recently added instance. In the example the once('ping') listener is removed:

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

function pong() {
  console.log('pong');
}

ee.on('ping', pong);
ee.once('ping', pong);
ee.removeListener('ping', pong);

ee.emit('ping');
ee.emit('ping');

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

Type Parameters​

K​

K extends keyof BakitClientEvents

Parameters​

event​

K

listener​

(...args) => void

Returns​

this

Since​

v0.1.26

Overrides​

Client.removeListener