ruvyrias / Exports / Ruvyrias

Class: Ruvyrias

Represents the main Ruvyrias instance, coordinating interactions with nodes and players.

Hierarchy

EventEmitter

↳ Ruvyrias

Constructors

constructor

Properties

Accessors

leastUsedNodes

Methods

Constructors

constructor

• new Ruvyrias(client, nodes, options): Ruvyrias

This is the main class of Ruvyrias

Parameters

Name	Type	Description
`client`	`any`	VoiceClient for Ruvyrias library to use to connect to lavalink node server (discord.js, eris, oceanic)
`nodes`	`NodeGroup`[]	Node
`options`	`Omit`<`RuvyriasOptions`, `"resumeTimeout"` \| `"clientName"` \| `"clientId"` \| `"clientVersion"` \| `"isActivated"`>	RuvyriasOptions

Returns

Ruvyrias

Ruvyrias

Defined in

src/Ruvyrias.ts:353

Properties

_nodes

• Private Readonly _nodes: NodeGroup[]

Defined in

src/Ruvyrias.ts:340

client

• Readonly client: any

Defined in

src/Ruvyrias.ts:339

nodes

• nodes: Map<string, Node>

players

• players: Map<string, Player>

Defined in

src/Ruvyrias.ts:343

send

• send: null | Function

Defined in

src/Ruvyrias.ts:344

captureRejectionSymbol

▪ Static Readonly captureRejectionSymbol: typeof captureRejectionSymbol

Value: Symbol.for('nodejs.rejection')

See how to write a custom rejection handler.

Since

v13.4.0, v12.16.0

Defined in

node_modules/.pnpm/@types+node@20.12.7/node_modules/@types/node/events.d.ts:415

captureRejections

▪ Static captureRejections: boolean

Value: boolean

Change the default captureRejections option on all new EventEmitter objects.

Since

v13.4.0, v12.16.0

Defined in

node_modules/.pnpm/@types+node@20.12.7/node_modules/@types/node/events.d.ts:422

defaultMaxListeners

▪ Static defaultMaxListeners: number

By default, a maximum of 10 listeners can be registered for any single event. This limit can be changed for individual EventEmitter instances using the emitter.setMaxListeners(n) method. To change the default for allEventEmitter instances, the events.defaultMaxListenersproperty can be used. If this value is not a positive number, a RangeErroris thrown.

Take caution when setting the events.defaultMaxListeners because the change affects allEventEmitter instances, including those created before the change is made. However, calling emitter.setMaxListeners(n) still has precedence over events.defaultMaxListeners.

This is not a hard limit. The EventEmitter instance will allow more listeners to be added but will output a trace warning to stderr indicating that a "possible EventEmitter memory leak" has been detected. For any singleEventEmitter, the emitter.getMaxListeners() and emitter.setMaxListeners()methods can be used to temporarily avoid this warning:

import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.setMaxListeners(emitter.getMaxListeners() + 1);
emitter.once('event', () => {
  // do stuff
  emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0));
});

The --trace-warnings command-line flag can be used to display the stack trace for such warnings.

The emitted warning can be inspected with process.on('warning') and will have the additional emitter, type, and count properties, referring to the event emitter instance, the event's name and the number of attached listeners, respectively. Its name property is set to 'MaxListenersExceededWarning'.

Since

v0.11.2

Defined in

node_modules/.pnpm/@types+node@20.12.7/node_modules/@types/node/events.d.ts:459

errorMonitor

▪ Static Readonly 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.

Since

v13.6.0, v12.17.0

Defined in

node_modules/.pnpm/@types+node@20.12.7/node_modules/@types/node/events.d.ts:408

Accessors

leastUsedNodes

• get leastUsedNodes(): Node[]

Gets an array of least used nodes from the Ruvyrias instance.

Returns

Node[]

An array of least used nodes.

Defined in

src/Ruvyrias.ts:605

Methods

[captureRejectionSymbol]

▸ [captureRejectionSymbol]<K>(error, event, ...args): void

Type parameters

Name
`K`

Parameters

Name	Type
`error`	`Error`
`event`	`string` \| `symbol`
`...args`	`AnyRest`

Returns

void

Defined in

node_modules/.pnpm/@types+node@20.12.7/node_modules/@types/node/events.d.ts:125

addListener

▸ addListener<K>(eventName, listener): this

Alias for emitter.on(eventName, listener).

Type parameters

Name
`K`

Parameters

Name	Type
`eventName`	`string` \| `symbol`
`listener`	(...`args`: `any`[]) => `void`

Returns

this

Since

v0.1.26

Defined in

node_modules/.pnpm/@types+node@20.12.7/node_modules/@types/node/events.d.ts:558

addNode

▸ addNode(options): Promise<Node>

Adds a node to the Ruvyrias instance.

Parameters

Name	Type	Description
`options`	`NodeGroup`	NodeGroup containing node configuration.

Returns

Promise<Node>

The created Node instance.

Defined in

src/Ruvyrias.ts:459

createConnection

▸ createConnection(options): Player

Creates a player connection for the specified guild using the provided options.

Parameters

Name	Type	Description
`options`	`ConnectionOptions`	Options for creating the player connection.

Returns

Player

The created or existing Player instance for the specified guild.

Defined in

src/Ruvyrias.ts:530

createPlayer

▸ createPlayer(node, options): Player

Creates a player instance for the specified guild using the provided node and options.

Parameters

Name	Type	Description
`node`	`Node`	The node to associate with the player.
`options`	`ConnectionOptions`	Options for creating the player.

Returns

Player

The created Player instance.

Defined in

src/Ruvyrias.ts:564

decodeTrack

▸ decodeTrack(track, node?): Promise<TrackData>

Decode a track from Ruvyrias instance.

Parameters

Name	Type	Description
`track`	`string`	The encoded track.
`node?`	`Node`	The node to decode the track on. If not provided, the least used node will be used.

Returns

Promise<TrackData>

A promise that resolves to the decoded track.

Defined in

src/Ruvyrias.ts:639

decodeTracks

▸ decodeTracks(tracks, node?): Promise<Track[]>

Decode tracks from Ruvyrias instance.

Parameters

Name	Type	Description
`tracks`	`string`[]	The encoded strings.
`node?`	`Node`	The node to decode the tracks on. If not provided, the least used node will be used.

Returns

Promise<Track[]>

A promise that resolves to an array of decoded tracks.

Defined in

src/Ruvyrias.ts:651

destroyPlayer

▸ destroyPlayer(guildId): null | boolean

Destroys the player instance for the specified guild using the provided guild ID.

Parameters

Name	Type	Description
`guildId`	`string`	The ID of the guild associated with the player instance.

Returns

null | boolean

A Promise that resolves with a boolean indicating success or null if no specific value is needed.

Defined in

src/Ruvyrias.ts:580

emit

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

Emits the specified event with the provided arguments.

Type parameters

Name	Type
`K`	extends keyof `RuvyriasEvents`

Parameters

Name	Type	Description
`event`	`K`	The event name to emit.
`...args`	`Parameters`<`RuvyriasEvents`[`K`]>	The arguments to pass to the event listeners.

Returns

boolean

Returns true if event had listeners, false otherwise.

Defined in

src/Ruvyrias.ts:324

eventNames

▸ eventNames(): (string | symbol)[]

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

import { EventEmitter } from 'node: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) ]

Returns

(string | symbol)[]

Since

v6.0.0

Defined in

node_modules/.pnpm/@types+node@20.12.7/node_modules/@types/node/events.d.ts:883

get

▸ get(guildId): null | Player

Get a player from Ruvyrias instance.

Parameters

Name	Type	Description
`guildId`	`string`	Guild ID.

Returns

null | Player

The player instance for the specified guild or undefined in case of nothing.

Defined in

src/Ruvyrias.ts:704

getLavalinkInfo

▸ getLavalinkInfo(name): Promise<NodeInfoResponse>

Get lavalink info from Ruvyrias instance

Parameters

Name	Type	Description
`name`	`string`	The name of the node

Returns

Promise<NodeInfoResponse>

Useful information about the node.

Defined in

src/Ruvyrias.ts:662

getLavalinkStatus

▸ getLavalinkStatus(name): Promise<NodeStatsResponse>

Get lavalink status from Ruvyrias instance

Parameters

Name	Type	Description
`name`	`string`	The name of the node

Returns

Promise<NodeStatsResponse>

The stats from the node

Defined in

src/Ruvyrias.ts:676

getLavalinkVersion

▸ getLavalinkVersion(name): Promise<string>

Get the current lavalink version of the node

Parameters

Name	Type	Description
`name`	`string`	The name of the node

Returns

Promise<string>

The version of the node

Defined in

src/Ruvyrias.ts:690

getMaxListeners

▸ getMaxListeners(): number

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

Returns

number

Since

v1.0.0

Defined in

node_modules/.pnpm/@types+node@20.12.7/node_modules/@types/node/events.d.ts:735

getNode

▸ getNode(identifier?): Promise<Node | Node[]>

Retrieves a node or an array of nodes from the Ruvyrias instance based on the specified identifier.

Parameters

Name	Type	Default value	Description
`identifier`	`string`	`'auto'`	Node name. If set to 'auto', it returns the least used nodes.

Returns

Promise<Node | Node[]>

A Node instance or an array of Node instances.

Defined in

src/Ruvyrias.ts:509

getNodeByRegion

▸ getNodeByRegion(region): Node[]

Retrieves an array of nodes from the Ruvyrias instance based on the specified region.

Parameters

Name	Type	Description
`region`	`string`	Region of the node.

Returns

Node[]

An array of Node instances.

Defined in

src/Ruvyrias.ts:487

init

▸ init(client): Promise<Ruvyrias>

Initializes the Ruvyrias instance with the specified VoiceClient.

Parameters

Name	Type	Description
`client`	`any`	VoiceClient for the Ruvyrias library to use to connect to the Lavalink node server (discord.js, eris, oceanic).

Returns

Promise<Ruvyrias>

The current Ruvyrias instance.

Defined in

src/Ruvyrias.ts:380

listenerCount

▸ listenerCount<K>(eventName, listener?): number

Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

Type parameters

Name
`K`

Parameters

Name	Type	Description
`eventName`	`string` \| `symbol`	The name of the event being listened for
`listener?`	`Function`	The event handler function

Returns

number

Since

v3.2.0

Defined in

node_modules/.pnpm/@types+node@20.12.7/node_modules/@types/node/events.d.ts:829

listeners

▸ listeners<K>(eventName): Function[]

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

server.on('connection', (stream) => {
  console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]

Type parameters

Name
`K`

Parameters

Name	Type
`eventName`	`string` \| `symbol`

Returns

Function[]

Since

v0.1.26

Defined in

node_modules/.pnpm/@types+node@20.12.7/node_modules/@types/node/events.d.ts:748

off

▸ off<K>(event, listener): this

Removes the specified listener from the event.

Type parameters

Name	Type
`K`	extends keyof `RuvyriasEvents`

Parameters

Name	Type	Description
`event`	`K`	The event name.
`listener`	`RuvyriasEvents`[`K`]	The listener function to remove.

Returns

this

The Ruvyrias instance.

Defined in

src/Ruvyrias.ts:332

on

▸ on<K>(event, listener): this

Adds a listener function to the specified event.

Type parameters

Name	Type
`K`	extends keyof `RuvyriasEvents`

Parameters

Name	Type	Description
`event`	`K`	The event name.
`listener`	`RuvyriasEvents`[`K`]	The listener function to be called when the event is emitted.

Returns

this

The Ruvyrias instance.

Defined in

src/Ruvyrias.ts:307

once

▸ once<K>(event, listener): this

Adds a one-time listener function to the specified event. The listener will be removed after it is invoked once.

Type parameters

Name	Type
`K`	extends keyof `RuvyriasEvents`

Parameters

Name	Type	Description
`event`	`K`	The event name.
`listener`	`RuvyriasEvents`[`K`]	The listener function to be called when the event is emitted.

Returns

this

The Ruvyrias instance.

Defined in

src/Ruvyrias.ts:316

packetUpdate

▸ packetUpdate(packet): Promise<void>

Handles Voice State Update and Voice Server Update packets from the Discord API.

Parameters

Name	Type	Description
`packet`	`Packet`	Packet from Discord API.

Returns

Promise<void>

Defined in

src/Ruvyrias.ts:440

prependListener

▸ prependListener<K>(eventName, listener): this

Adds the listener function to the beginning 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 eventNameand listener will result in the listener being added, and called, multiple times.

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

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

Type parameters

Name
`K`

Parameters

Name	Type	Description
`eventName`	`string` \| `symbol`	The name of the event.
`listener`	(...`args`: `any`[]) => `void`	The callback function

Returns

this

Since

v6.0.0

Defined in

node_modules/.pnpm/@types+node@20.12.7/node_modules/@types/node/events.d.ts:847

prependOnceListener

▸ prependOnceListener<K>(eventName, listener): this

Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

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

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

Type parameters

Name
`K`

Parameters

Name	Type	Description
`eventName`	`string` \| `symbol`	The name of the event.
`listener`	(...`args`: `any`[]) => `void`	The callback function

Returns

this

Since

v6.0.0

Defined in

node_modules/.pnpm/@types+node@20.12.7/node_modules/@types/node/events.d.ts:863

rawListeners

▸ rawListeners<K>(eventName): Function[]

Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));

// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];

// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();

// Logs "log once" to the console and removes the listener
logFnWrapper();

emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');

// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');

Type parameters

Name
`K`

Parameters

Name	Type
`eventName`	`string` \| `symbol`

Returns

Function[]

Since

v9.4.0

Defined in

node_modules/.pnpm/@types+node@20.12.7/node_modules/@types/node/events.d.ts:779

removeAllListeners

▸ removeAllListeners(eventName?): this

Removes all listeners, or those of the specified eventName.

It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

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

Parameters

Name	Type
`eventName?`	`string` \| `symbol`

Returns

this

Since

v0.1.26

Defined in

node_modules/.pnpm/@types+node@20.12.7/node_modules/@types/node/events.d.ts:719

removeConnection

▸ removeConnection(guildId): Promise<boolean>

Removes a player associated with the specified guild from Ruvyrias instance.

Parameters

Name	Type	Description
`guildId`	`string`	The ID of the guild for which to remove the player.

Returns

Promise<boolean>

A promise that resolves to true if the player is successfully removed; otherwise, false.

Defined in

src/Ruvyrias.ts:596

removeListener

▸ removeListener<K>(eventName, listener): this

Removes the specified listener from the listener array for the event namedeventName.

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 anyremoveListener() 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

Name
`K`

Parameters

Name	Type
`eventName`	`string` \| `symbol`
`listener`	(...`args`: `any`[]) => `void`

Returns

this

Since

v0.1.26

Defined in

node_modules/.pnpm/@types+node@20.12.7/node_modules/@types/node/events.d.ts:703

removeNode

▸ removeNode(identifier): Promise<boolean>

Removes a node from the Ruvyrias instance.

Parameters

Name	Type	Description
`identifier`	`string`	Node name.

Returns

Promise<boolean>

Whether the node was successfully removed.

Defined in

src/Ruvyrias.ts:471

resolve

▸ resolve(options, node?): Promise<Response>

Resolves a track using the specified options and node in Ruvyrias instance.

Parameters

Name	Type	Description
`options`	`ResolveOptions`	The options for resolving the track.
`node?`	`Node`	The node to use for resolving the track. If not provided, the least used node will be used.

Returns

Promise<Response>

A promise that resolves to a Response object containing information about the resolved track.

Defined in

src/Ruvyrias.ts:617

setMaxListeners

▸ setMaxListeners(n): this

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.

Parameters

Name	Type
`n`	`number`

Returns

this

Since

v0.3.5

Defined in

node_modules/.pnpm/@types+node@20.12.7/node_modules/@types/node/events.d.ts:729

addAbortListener

▸ addAbortListener(signal, resource): Disposable

Listens once to the abort event on the provided signal.

Listening to the abort event on abort signals is unsafe and may lead to resource leaks since another third party with the signal can call e.stopImmediatePropagation(). Unfortunately Node.js cannot change this since it would violate the web standard. Additionally, the original API makes it easy to forget to remove listeners.

This API allows safely using AbortSignals in Node.js APIs by solving these two issues by listening to the event such that stopImmediatePropagation does not prevent the listener from running.

Returns a disposable so that it may be unsubscribed from more easily.

import { addAbortListener } from 'node:events';

function example(signal) {
  let disposable;
  try {
    signal.addEventListener('abort', (e) => e.stopImmediatePropagation());
    disposable = addAbortListener(signal, (e) => {
      // Do something when signal is aborted.
    });
  } finally {
    disposable?.[Symbol.dispose]();
  }
}

Parameters

Name	Type
`signal`	`AbortSignal`
`resource`	(`event`: `Event`) => `void`

Returns

Disposable

Disposable that removes the abort listener.

Since

v20.5.0

Defined in

node_modules/.pnpm/@types+node@20.12.7/node_modules/@types/node/events.d.ts:400

getEventListeners

▸ getEventListeners(emitter, name): Function[]

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.

import { getEventListeners, EventEmitter } from 'node:events';

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

Parameters

Name	Type
`emitter`	`EventEmitter`<`DefaultEventMap`> \| `_DOMEventTarget`
`name`	`string` \| `symbol`

Returns

Function[]

Since

v15.2.0, v14.17.0

Defined in

node_modules/.pnpm/@types+node@20.12.7/node_modules/@types/node/events.d.ts:321

getMaxListeners

▸ getMaxListeners(emitter): number

Returns the currently set max amount of listeners.

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

For EventTargets this is the only way to get the max event listeners for the event target. If the number of event handlers on a single EventTarget exceeds the max set, the EventTarget will print a warning.

import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';

{
  const ee = new EventEmitter();
  console.log(getMaxListeners(ee)); // 10
  setMaxListeners(11, ee);
  console.log(getMaxListeners(ee)); // 11
}
{
  const et = new EventTarget();
  console.log(getMaxListeners(et)); // 10
  setMaxListeners(11, et);
  console.log(getMaxListeners(et)); // 11
}

Parameters

Name	Type
`emitter`	`EventEmitter`<`DefaultEventMap`> \| `_DOMEventTarget`

Returns

number

Since

v19.9.0

Defined in

node_modules/.pnpm/@types+node@20.12.7/node_modules/@types/node/events.d.ts:350

listenerCount

▸ listenerCount(emitter, eventName): number

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

import { EventEmitter, listenerCount } from 'node:events';

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

Parameters

Name	Type	Description
`emitter`	`EventEmitter`<`DefaultEventMap`>	The emitter to query
`eventName`	`string` \| `symbol`	The event name

Returns

number

Since

v0.9.12

Deprecated

Since v3.2.0 - Use listenerCount instead.

Defined in

node_modules/.pnpm/@types+node@20.12.7/node_modules/@types/node/events.d.ts:293

on

▸ on(emitter, eventName, options?): AsyncIterableIterator<any>

import { on, EventEmitter } from 'node:events';
import process from 'node:process';

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:

import { on, EventEmitter } from 'node:events';
import process from 'node:process';

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());

Parameters

Name	Type	Description
`emitter`	`EventEmitter`<`DefaultEventMap`>	-
`eventName`	`string`	The name of the event being listened for
`options?`	`StaticEventEmitterOptions`	-

Returns

AsyncIterableIterator<any>

that iterates eventName events emitted by the emitter

Since

v13.6.0, v12.16.0

Defined in

node_modules/.pnpm/@types+node@20.12.7/node_modules/@types/node/events.d.ts:271

once

▸ once(emitter, eventName, options?): Promise<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.

import { once, EventEmitter } from 'node:events';
import process from 'node:process';

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.error('error happened', err);
}

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:

import { EventEmitter, once } from 'node:events';

const ee = new EventEmitter();

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

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

// Prints: ok boom

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

import { EventEmitter, once } from 'node: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!

Parameters

Name	Type
`emitter`	`EventEmitter`<`DefaultEventMap`>
`eventName`	`string` \| `symbol`
`options?`	`StaticEventEmitterOptions`

Returns

Promise<any[]>

Since

v11.13.0, v10.16.0

Defined in

node_modules/.pnpm/@types+node@20.12.7/node_modules/@types/node/events.d.ts:206

▸ once(emitter, eventName, options?): Promise<any[]>

Parameters

Name	Type
`emitter`	`_DOMEventTarget`
`eventName`	`string`
`options?`	`StaticEventEmitterOptions`

Returns

Promise<any[]>

Defined in

node_modules/.pnpm/@types+node@20.12.7/node_modules/@types/node/events.d.ts:211

setMaxListeners

▸ setMaxListeners(n?, ...eventTargets): void

import { setMaxListeners, EventEmitter } from 'node:events';

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

setMaxListeners(5, target, emitter);

Parameters

Name	Type	Description
`n?`	`number`	A non-negative number. The maximum number of listeners per `EventTarget` event.
`...eventTargets`	(`EventEmitter`<`DefaultEventMap`> \| `_DOMEventTarget`)[]	-

Returns

void

Since

v15.4.0

Defined in

node_modules/.pnpm/@types+node@20.12.7/node_modules/@types/node/events.d.ts:365

Class: Ruvyrias

Hierarchy​

Table of contents​

Constructors​

Properties​

Accessors​

Methods​

Constructors​

constructor​

Parameters​

Returns​

Defined in​

Properties​

_nodes​

Defined in​

client​

Defined in​

nodes​

Defined in​

options​

Defined in​

players​

Defined in​

send​

Defined in​

captureRejectionSymbol​

Defined in​

captureRejections​

Defined in​

defaultMaxListeners​

Defined in​

errorMonitor​

Defined in​

Accessors​

leastUsedNodes​

Returns​

Defined in​

Methods​

[captureRejectionSymbol]​

Type parameters​

Parameters​

Returns​

Defined in​

addListener​

Type parameters​

Parameters​

Returns​

Defined in​

addNode​

Parameters​

Returns​

Defined in​

createConnection​

Parameters​

Returns​

Defined in​

createPlayer​

Parameters​

Returns​

Defined in​

decodeTrack​

Parameters​

Returns​

Defined in​

decodeTracks​

Parameters​

Returns​

Defined in​

destroyPlayer​

Parameters​

Returns​

Defined in​

emit​

Type parameters​

Parameters​

Returns​

Defined in​

eventNames​

Returns​

Defined in​

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns

Defined in

Properties

_nodes

Defined in

client

Defined in

nodes

Defined in

options

Defined in

players

Defined in

send

Defined in

captureRejectionSymbol

Defined in

captureRejections

Defined in

defaultMaxListeners

Defined in

errorMonitor

Defined in

Accessors

leastUsedNodes

Returns

Defined in

Methods

[captureRejectionSymbol]

Type parameters

Parameters

Returns

Defined in

addListener

Type parameters

Parameters

Returns

Defined in

addNode

Parameters

Returns

Defined in

createConnection

Parameters

Returns

Defined in

createPlayer

Parameters

Returns

Defined in

decodeTrack

Parameters

Returns

Defined in

decodeTracks

Parameters

Returns

Defined in

destroyPlayer

Parameters

Returns

Defined in

emit

Type parameters

Parameters

Returns

Defined in

eventNames

Returns

Defined in

get