readStream.isRaw

Значение типа boolean, равное true, если в данный момент TTY настроен для работы в режиме необработанных данных.

При запуске процесса этот флаг всегда имеет значение false, даже если терминал работает в режиме необработанных данных. Его значение изменится при последующих вызовах setRawMode.

readStream.isTTY

Значение типа boolean, которое всегда равно true для экземпляров tty.ReadStream.

readStream.setRawMode(mode)

• mode <boolean> Если значение равно true, настраивает tty.ReadStream для работы в режиме необработанных данных. Если значение равно false, настраивает tty.ReadStream для работы в режиме по умолчанию. Свойству readStream.isRaw будет присвоено значение итогового режима.
• Возвращает: <this> Экземпляр потока чтения.

Позволяет настроить tty.ReadStream для работы в режиме необработанных данных.

В этом режиме ввод всегда доступен посимвольно, без учета модификаторов. Кроме того, отключается вся специальная обработка символов терминалом, включая отображение вводимых символов. В этом режиме нажатие Ctrl+C больше не приводит к возникновению SIGINT.

new tty.ReadStream(fd[, options])

• fd <number> Дескриптор файла, связанный с TTY.
• options <Object> Параметры, передаваемые родительскому net.Socket; см. options конструктора net.Socket.
• Возвращает: <tty.ReadStream>

Создает ReadStream для fd, связанного с TTY.

new tty.WriteStream(fd)

• fd <number> Дескриптор файла, связанный с TTY.
• Возвращает: <tty.WriteStream>

Создает WriteStream для fd, связанного с TTY.

Событие: 'resize'

Событие 'resize' возникает при изменении свойства writeStream.columns или writeStream.rows. При вызове функции обратного вызова обработчика ей не передаются аргументы.

process.stdout.on('resize', () => {
  console.log('screen size has changed!');
  console.log(`${process.stdout.columns}x${process.stdout.rows}`);
}); copy

writeStream.clearLine(dir[, callback])

• dir <number>
  • -1: влево от курсора
  • 1: вправо от курсора
  • 0: вся строка
• callback <Function> Вызывается после завершения операции.
• Возвращает: <boolean> false, если поток хочет, чтобы вызывающий код дождался возникновения события 'drain', прежде чем продолжить запись дополнительных данных; в противном случае — true.

writeStream.clearLine() очищает текущую строку этого WriteStream в направлении, заданном параметром dir.

writeStream.clearScreenDown([callback])

• callback <Function> Вызывается после завершения операции.
• Возвращает: <boolean> false, если поток хочет, чтобы вызывающий код дождался возникновения события 'drain', прежде чем продолжить запись дополнительных данных; в противном случае — true.

writeStream.clearScreenDown() очищает этот WriteStream от текущего положения курсора до конца экрана.

writeStream.columns

Значение типа number, задающее текущее количество столбцов TTY. Это свойство обновляется при возникновении события 'resize'.

writeStream.cursorTo(x[, y][, callback])

• x <number>
• y <number>
• callback <Function> Вызывается после завершения операции.
• Возвращает: <boolean> false, если поток хочет, чтобы вызывающий код дождался возникновения события 'drain', прежде чем продолжить запись дополнительных данных; в противном случае — true.

writeStream.cursorTo() перемещает курсор этого WriteStream в указанное положение.

writeStream.getColorDepth([env])

• env <Object> Объект, содержащий проверяемые переменные среды. Это позволяет имитировать использование определенного терминала. По умолчанию: process.env.
• Возвращает: <number>

Возвращает:

• 1 для 2,
• 4 для 16,
• 8 для 256,
• 24 для 16 777 216 поддерживаемых цветов.

Используйте этот метод, чтобы определить, какие цвета поддерживает терминал. Из-за особенностей работы с цветами в терминалах возможны как ложноположительные, так и ложноотрицательные результаты. Это зависит от сведений о процессе и переменных среды, которые могут неверно указывать используемый терминал. Можно передать объект env, чтобы имитировать использование определенного терминала. Это может быть полезно для проверки поведения конкретных настроек среды.

Чтобы задать определенную поддержку цветов, используйте одну из следующих настроек среды.

• 2 цвета: FORCE_COLOR = 0 (отключает цвета)
• 16 цветов: FORCE_COLOR = 1
• 256 цветов: FORCE_COLOR = 2
• 16 777 216 цветов: FORCE_COLOR = 3

Отключить поддержку цветов также можно с помощью переменных среды NO_COLOR и NODE_DISABLE_COLORS.

writeStream.getWindowSize()

• Возвращает: <number[]>

writeStream.getWindowSize() возвращает размер TTY, соответствующего этому WriteStream. Массив имеет тип [numColumns, numRows], где numColumns и numRows задают количество столбцов и строк в соответствующем TTY.

writeStream.hasColors([count][, env])

• count <integer> Требуемое количество цветов (не менее 2). По умолчанию: 16.
• env <Object> Объект, содержащий проверяемые переменные среды. Это позволяет имитировать использование определенного терминала. По умолчанию: process.env.
• Возвращает: <boolean>

Возвращает true, если writeStream поддерживает не меньше цветов, чем указано в count. Минимальный уровень поддержки — 2 цвета (черный и белый).

Для этого метода возможны те же ложноположительные и ложноотрицательные результаты, что и для writeStream.getColorDepth().

process.stdout.hasColors();
// Returns true or false depending on if `stdout` supports at least 16 colors.
process.stdout.hasColors(256);
// Returns true or false depending on if `stdout` supports at least 256 colors.
process.stdout.hasColors({ TMUX: '1' });
// Returns true.
process.stdout.hasColors(2 ** 24, { TMUX: '1' });
// Returns false (the environment setting pretends to support 2 ** 8 colors). copy

writeStream.isTTY

Значение типа boolean, которое всегда равно true.

writeStream.moveCursor(dx, dy[, callback])

• dx <number>
• dy <number>
• callback <Function> Вызывается после завершения операции.
• Возвращает: <boolean> false, если поток хочет, чтобы вызывающий код дождался возникновения события 'drain', прежде чем продолжить запись дополнительных данных; в противном случае — true.

writeStream.moveCursor() перемещает курсор этого WriteStream относительно его текущего положения.

writeStream.rows

Значение типа number, задающее текущее количество строк TTY. Это свойство обновляется при возникновении события 'resize'.