ReadLineInterface

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/readline/promises.d.ts:16

Instances of the readlinePromises.Interface class are constructed using the readlinePromises.createInterface() method. Every instance is associated with a single input Readable stream and a single output Writable stream. The output stream is used to print prompts for user input that arrives on, and is read from, the input stream.

Since

v17.0.0

Extends

Interface

Properties

cursor

readonly cursor: number

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/readline.d.ts:93

The cursor position relative to rl.line.

This will track where the current cursor lands in the input string, when reading input from a TTY stream. The position of cursor determines the portion of the input string that will be modified as input is processed, as well as the column where the terminal caret will be rendered.

Since

v0.1.98

Inherited from

_Interface.cursor

line

readonly line: string

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/readline.d.ts:83

The current input data being processed by node.

This can be used when collecting input from a TTY stream to retrieve the current value that has been processed thus far, prior to the line event being emitted. Once the line event has been emitted, this property will be an empty string.

Be aware that modifying the value during the instance runtime may have unintended consequences if rl.cursor is not also controlled.

If not using a TTY stream for input, use the 'line' event.

One possible use case would be as follows:

const values = ['lorem ipsum', 'dolor sit amet'];
const rl = readline.createInterface(process.stdin);
const showResults = debounce(() => {
  console.log(
    '\n',
    values.filter((val) => val.startsWith(rl.line)).join(' '),
  );
}, 300);
process.stdin.on('keypress', (c, k) => {
  showResults();
});

Since

v0.1.98

Inherited from

_Interface.line

terminal

readonly terminal: boolean

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/readline.d.ts:52

Inherited from

_Interface.terminal

Methods

[asyncIterator]()

[asyncIterator](): AsyncIterator<string>

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/readline.d.ts:221

Returns

AsyncIterator<string>

Inherited from

_Interface.[asyncIterator]

[captureRejectionSymbol]()?

optional [captureRejectionSymbol](error, event, …args): void

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:87

The Symbol.for('nodejs.rejection') method is called in case a promise rejection happens when emitting an event and captureRejections is enabled on the emitter. It is possible to use events.captureRejectionSymbol in place of Symbol.for('nodejs.rejection').

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

class MyClass extends EventEmitter {
  constructor() {
    super({ captureRejections: true });
  }

  [captureRejectionSymbol](err, event, ...args) {
    console.log('rejection happened for', event, 'with', err, ...args);
    this.destroy(err);
  }

  destroy(err) {
    // Tear the resource down here.
  }
}

Parameters

error

Error

event

string | symbol

args

…any[]

Returns

void

Since

v13.4.0, v12.16.0

Inherited from

_Interface.[captureRejectionSymbol]

[dispose]()

[dispose](): void

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/readline.d.ts:189

Alias for rl.close().

Returns

void

Since

v22.15.0

Inherited from

_Interface.[dispose]

addListener()

Call Signature

addListener<E>(eventName, listener): this

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:821

Alias for emitter.on(eventName, listener).

Type Parameters

E

E extends keyof InterfaceEventMap

Parameters

eventName

E

listener

(…args) => void

Returns

this

Since

v0.1.26

Inherited from

_Interface.addListener

Call Signature

addListener(eventName, listener): this

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:822

Alias for emitter.on(eventName, listener).

Parameters

eventName

string | symbol

listener

(…args) => void

Returns

this

Since

v0.1.26

Inherited from

_Interface.addListener

close()

close(): void

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/readline.d.ts:184

The rl.close() method closes the Interface instance and relinquishes control over the input and output streams. When called, the 'close' event will be emitted.

Calling rl.close() does not immediately stop other events (including 'line') from being emitted by the Interface instance.

Returns

void

Since

v0.1.98

Inherited from

_Interface.close

emit()

Call Signature

emit<E>(eventName, …args): boolean

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:823

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

E

E extends keyof InterfaceEventMap

Parameters

eventName

E

args

…InterfaceEventMap[E]

Returns

boolean

Since

v0.1.26

Inherited from

_Interface.emit

Call Signature

emit(eventName, …args): boolean

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:824

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

Parameters

eventName

string | symbol

args

…any[]

Returns

boolean

Since

v0.1.26

Inherited from

_Interface.emit

eventNames()

eventNames(): (string | symbol)[]

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:154

Returns an array listing the events for which the emitter has registered listeners.

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

Inherited from

_Interface.eventNames

getCursorPos()

getCursorPos(): CursorPos

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/readline.d.ts:220

Returns the real position of the cursor in relation to the input prompt + string. Long input (wrapping) strings, as well as multiple line prompts are included in the calculations.

Returns

CursorPos

Since

v13.5.0, v12.16.0

Inherited from

_Interface.getCursorPos

getMaxListeners()

getMaxListeners(): number

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:161

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

Returns

number

Since

v1.0.0

Inherited from

_Interface.getMaxListeners

getPrompt()

getPrompt(): string

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/readline.d.ts:99

The rl.getPrompt() method returns the current prompt used by rl.prompt().

Returns

string

the current prompt string

Since

v15.3.0, v14.17.0

Inherited from

_Interface.getPrompt

listenerCount()

Call Signature

listenerCount<E>(eventName, listener?): number

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:825

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

E

E extends keyof InterfaceEventMap

Parameters

eventName

E

The name of the event being listened for

listener?

(…args) => void

The event handler function

Returns

number

Since

v3.2.0

Inherited from

_Interface.listenerCount

Call Signature

listenerCount(eventName, listener?): number

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:826

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.

Parameters

eventName

string | symbol

The name of the event being listened for

listener?

(…args) => void

The event handler function

Returns

number

Since

v3.2.0

Inherited from

_Interface.listenerCount

listeners()

Call Signature

listeners<E>(eventName): (…args) => void[]

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:827

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

E

E extends keyof InterfaceEventMap

Parameters

eventName

E

Returns

(…args) => void[]

Since

v0.1.26

Inherited from

_Interface.listeners

Call Signature

listeners(eventName): (…args) => void[]

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:828

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] ]

Parameters

eventName

string | symbol

Returns

(…args) => void[]

Since

v0.1.26

Inherited from

_Interface.listeners

off()

Call Signature

off<E>(eventName, listener): this

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:829

Alias for emitter.removeListener().

Type Parameters

E

E extends keyof InterfaceEventMap

Parameters

eventName

E

listener

(…args) => void

Returns

this

Since

v10.0.0

Inherited from

_Interface.off

Call Signature

off(eventName, listener): this

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:830

Alias for emitter.removeListener().

Parameters

eventName

string | symbol

listener

(…args) => void

Returns

this

Since

v10.0.0

Inherited from

_Interface.off

on()

Call Signature

on<E>(eventName, listener): this

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:831

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

E

E extends keyof InterfaceEventMap

Parameters

eventName

E

The name of the event.

listener

(…args) => void

The callback function

Returns

this

Since

v0.1.101

Inherited from

_Interface.on

Call Signature

on(eventName, listener): this

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:832

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

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

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

Parameters

eventName

string | symbol

The name of the event.

listener

(…args) => void

The callback function

Returns

this

Since

v0.1.101

Inherited from

_Interface.on

once()

Call Signature

once<E>(eventName, listener): this

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:833

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

E

E extends keyof InterfaceEventMap

Parameters

eventName

E

The name of the event.

listener

(…args) => void

The callback function

Returns

this

Since

v0.3.0

Inherited from

_Interface.once

Call Signature

once(eventName, listener): this

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:834

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.

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

Parameters

eventName

string | symbol

The name of the event.

listener

(…args) => void

The callback function

Returns

this

Since

v0.3.0

Inherited from

_Interface.once

pause()

pause(): this

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/readline.d.ts:169

The rl.pause() method pauses the input stream, allowing it to be resumed later if necessary.

Calling rl.pause() does not immediately pause other events (including 'line') from being emitted by the Interface instance.

Returns

this

Since

v0.3.4

Inherited from

_Interface.pause

prependListener()

Call Signature

prependListener<E>(eventName, listener): this

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:835

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 eventName and 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

E

E extends keyof InterfaceEventMap

Parameters

eventName

E

The name of the event.

listener

(…args) => void

The callback function

Returns

this

Since

v6.0.0

Inherited from

_Interface.prependListener

Call Signature

prependListener(eventName, listener): this

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:836

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

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

Parameters

eventName

string | symbol

The name of the event.

listener

(…args) => void

The callback function

Returns

this

Since

v6.0.0

Inherited from

_Interface.prependListener

prependOnceListener()

Call Signature

prependOnceListener<E>(eventName, listener): this

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:837

Adds a one-time listener 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

E

E extends keyof InterfaceEventMap

Parameters

eventName

E

The name of the event.

listener

(…args) => void

The callback function

Returns

this

Since

v6.0.0

Inherited from

_Interface.prependOnceListener

Call Signature

prependOnceListener(eventName, listener): this

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:838

Adds a one-time listener 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.

Parameters

eventName

string | symbol

The name of the event.

listener

(…args) => void

The callback function

Returns

this

Since

v6.0.0

Inherited from

_Interface.prependOnceListener

prompt()

prompt(preserveCursor?): void

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/readline.d.ts:116

The rl.prompt() method writes the Interface instances configuredprompt to a new line in output in order to provide a user with a new location at which to provide input.

When called, rl.prompt() will resume the input stream if it has been paused.

If the Interface was created with output set to null or undefined the prompt is not written.

Parameters

preserveCursor?

boolean

If true, prevents the cursor placement from being reset to 0.

Returns

void

Since

v0.1.98

Inherited from

_Interface.prompt

question()

Call Signature

question(query): Promise<string>

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/readline/promises.d.ts:51

The rl.question() method displays the query by writing it to the output, waits for user input to be provided on input, then invokes the callback function passing the provided input as the first argument.

When called, rl.question() will resume the input stream if it has been paused.

If the Interface was created with output set to null or undefined the query is not written.

If the question is called after rl.close(), it returns a rejected promise.

Example usage:

const answer = await rl.question('What is your favorite food? ');
console.log(`Oh, so your favorite food is ${answer}`);

Using an AbortSignal to cancel a question.

const signal = AbortSignal.timeout(10_000);

signal.addEventListener('abort', () => {
  console.log('The food question timed out');
}, { once: true });

const answer = await rl.question('What is your favorite food? ', { signal });
console.log(`Oh, so your favorite food is ${answer}`);

Parameters

query

string

A statement or query to write to output, prepended to the prompt.

Returns

Promise<string>

A promise that is fulfilled with the user’s input in response to the query.

Since

v17.0.0

Overrides

_Interface.question

Call Signature

question(query, options): Promise<string>

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/readline/promises.d.ts:52

When called, rl.question() will resume the input stream if it has been paused.

If the Interface was created with output set to null or undefined the query is not written.

If the question is called after rl.close(), it returns a rejected promise.

Example usage:

const answer = await rl.question('What is your favorite food? ');
console.log(`Oh, so your favorite food is ${answer}`);

Using an AbortSignal to cancel a question.

const signal = AbortSignal.timeout(10_000);

signal.addEventListener('abort', () => {
  console.log('The food question timed out');
}, { once: true });

const answer = await rl.question('What is your favorite food? ', { signal });
console.log(`Oh, so your favorite food is ${answer}`);

Parameters

query

string

A statement or query to write to output, prepended to the prompt.

options

Abortable

Returns

Promise<string>

A promise that is fulfilled with the user’s input in response to the query.

Since

v17.0.0

Overrides

_Interface.question

rawListeners()

Call Signature

rawListeners<E>(eventName): (…args) => void[]

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:839

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

E

E extends keyof InterfaceEventMap

Parameters

eventName

E

Returns

(…args) => void[]

Since

v9.4.0

Inherited from

_Interface.rawListeners

Call Signature

rawListeners(eventName): (…args) => void[]

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:840

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

Parameters

eventName

string | symbol

Returns

(…args) => void[]

Since

v9.4.0

Inherited from

_Interface.rawListeners

removeAllListeners()

Call Signature

removeAllListeners<E>(eventName?): this

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:842

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.

Type Parameters

E

E extends keyof InterfaceEventMap

Parameters

eventName?

E

Returns

this

Since

v0.1.26

Inherited from

_Interface.removeAllListeners

Call Signature

removeAllListeners(eventName?): this

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:843

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

eventName?

string | symbol

Returns

this

Since

v0.1.26

Inherited from

_Interface.removeAllListeners

removeListener()

Call Signature

removeListener<E>(eventName, listener): this

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:844

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 from emit() 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 indexes 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

E

E extends keyof InterfaceEventMap

Parameters

eventName

E

listener

(…args) => void

Returns

this

Since

v0.1.26

Inherited from

_Interface.removeListener

Call Signature

removeListener(eventName, listener): this

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:845

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

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

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.

Parameters

eventName

string | symbol

listener

(…args) => void

Returns

this

Since

v0.1.26

Inherited from

_Interface.removeListener

resume()

resume(): this

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/readline.d.ts:174

The rl.resume() method resumes the input stream if it has been paused.

Returns

this

Since

v0.3.4

Inherited from

_Interface.resume

setMaxListeners()

setMaxListeners(n): this

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/events.d.ts:436

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 to Infinity (or 0) to indicate an unlimited number of listeners.

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

Parameters

n

number

Returns

this

Since

v0.3.5

Inherited from

_Interface.setMaxListeners

setPrompt()

setPrompt(prompt): void

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/readline.d.ts:104

The rl.setPrompt() method sets the prompt that will be written to output whenever rl.prompt() is called.

Parameters

prompt

string

Returns

void

Since

v0.1.98

Inherited from

_Interface.setPrompt

write()

Call Signature

write(data, key?): void

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/readline.d.ts:212

The rl.write() method will write either data or a key sequence identified by key to the output. The key argument is supported only if output is a TTY text terminal. See TTY keybindings for a list of key combinations.

If key is specified, data is ignored.

When called, rl.write() will resume the input stream if it has been paused.

If the Interface was created with output set to null or undefined the data and key are not written.

rl.write('Delete this!');
// Simulate Ctrl+U to delete the line written previously
rl.write(null, { ctrl: true, name: 'u' });

The rl.write() method will write the data to the readline Interface’s input as if it were provided by the user.

Parameters

data

string | Buffer<ArrayBufferLike>

key?

Key

Returns

void

Since

v0.1.98

Inherited from

_Interface.write

Call Signature

write(data, key): void

Defined in: _worktrees/docs-release/gaunt-sloth/node_modules/.pnpm/@types+node@26.1.2/node_modules/@types/node/readline.d.ts:213

If key is specified, data is ignored.

When called, rl.write() will resume the input stream if it has been paused.

If the Interface was created with output set to null or undefined the data and key are not written.

rl.write('Delete this!');
// Simulate Ctrl+U to delete the line written previously
rl.write(null, { ctrl: true, name: 'u' });

The rl.write() method will write the data to the readline Interface’s input as if it were provided by the user.

Parameters

data

string | Buffer<ArrayBufferLike> | null | undefined

key

Key

Returns

void

Since

v0.1.98

Inherited from

_Interface.write