Skip to main content

write

method Interface.prototype.write
Jump to headingInterface.prototype.write(
data: string | Buffer,
key?: Key,
): void

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 Jump to heading

Jump to headingdata: string | Buffer
optional
Jump to headingkey: Key

Return Type Jump to heading

void
Jump to headingInterface.prototype.write(
data:
undefined
| null
| string
| Buffer
,
key: Key,
): void

Parameters Jump to heading

Jump to headingdata:
undefined
| null
| string
| Buffer

Return Type Jump to heading

void
Back to top