Построчный ввод (`readline`)¶

Стабильность: 2 – Стабильная

АПИ является удовлетворительным. Совместимость с NPM имеет высший приоритет и не будет нарушена кроме случаев явной необходимости.

Модуль node:readline предоставляет интерфейс для чтения данных из потока Readable (например, process.stdin) по одной строке за раз.

Чтобы использовать API на основе обещаний:

MJSCJS

import * as readline from 'node:readline/promises';

const readline = require('node:readline/promises');

Чтобы использовать API обратного вызова и синхронизации:

MJSCJS

import * as readline from 'node:readline';

const readline = require('node:readline');

Следующий простой пример иллюстрирует базовое использование модуля node:readline.

MJSCJS

import * as readline from 'node:readline/promises';
import {
    stdin as input,
    stdout as output,
} from 'node:process';

const rl = readline.createInterface({ input, output });

const answer = await rl.question(
    'What do you think of Node.js? '
);

console.log(
    `Thank you for your valuable feedback: ${answer}`
);

rl.close();

const readline = require('node:readline');
const {
    stdin: input,
    stdout: output,
} = require('node:process');

const rl = readline.createInterface({ input, output });

rl.question('What do you think of Node.js? ', (answer) => {
    // TODO: Log the answer in a database
    console.log(
        `Thank you for your valuable feedback: ${answer}`
    );

    rl.close();
});

После вызова этого кода приложение Node.js не завершится, пока не будет закрыт readline.Interface, поскольку интерфейс ожидает получения данных в потоке input.

Класс: `InterfaceConstructor`¶

Наследует: <EventEmitter>

Экземпляры класса InterfaceConstructor создаются методами readlinePromises.createInterface() или readline.createInterface(). Каждый экземпляр связан с одним потоком input Readable и одним output Writable. Поток output используется для вывода приглашений к вводу; данные поступают и читаются из потока input.

Событие: `'close'`¶

Событие 'close' испускается в одном из случаев:

вызван rl.close() и экземпляр InterfaceConstructor отпустил потоки input и output;
поток input получил событие 'end';
на потоке input нажаты Ctrl+D (EOT);
на потоке input нажаты Ctrl+C (SIGINT), и на экземпляре InterfaceConstructor нет обработчика 'SIGINT'.

Обработчик вызывается без аргументов.

После события 'close' экземпляр InterfaceConstructor считается завершённым.

Событие: `'error'`¶

Событие 'error' испускается при ошибке на потоке input, связанном с интерфейсом node:readline Interface.

Обработчику передаётся один аргумент — объект Error.

Событие: `'line'`¶

Событие line возникает всякий раз, когда поток ввода получает ввод конца строки (\n, \r или \r\n). Обычно это происходит, когда пользователь нажимает клавишу Enter или Return.

Событие 'line' также испускается, если новые данные были прочитаны из потока, и этот поток заканчивается без маркера конца строки.

Функция слушателя вызывается со строкой, содержащей единственную строку полученного ввода.

rl.on('line', (input) => {
    console.log(`Received: ${input}`);
});

Событие: `history`¶

Событие 'history' генерируется всякий раз, когда массив истории изменяется.

Функция-слушатель вызывается с массивом, содержащим массив истории. В нем будут отражены все изменения, добавленные и удаленные строки благодаря historySize и removeHistoryDuplicates.

Основная цель - позволить слушателю сохранять историю. Слушатель также может изменять объект истории. Это может быть полезно для предотвращения добавления в историю определенных строк, например, пароля.

rl.on('history', (history) => {
    console.log(`Received: ${history}`);
});