readline w Node.js: odczyt danych od użytkownika w terminalu

Żeby odczytać dane od użytkownika w Node.js, utwórz interfejs readline na process.stdin i pytaj przez rl.question(). Node.js nie ma prompt(): wersja z przeglądarki otwiera okno dialogowe, a program w terminalu go nie ma. Nowoczesna forma używa readline/promises, gdzie await rl.question('Name? ') zwraca linię wpisaną przez użytkownika. Zamknij interfejs, gdy skończysz, bo inaczej program dalej czeka na dane.

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

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

const age = await rl.question('How old are you? ');
rl.close();

console.log(`Next year you will be ${Number(age) + 1}.`);

question() wypisało swoje pytanie, poczekało na jedną linię wejścia i zwróciło ją bez znaku nowej linii, więc program wypisał Next year you will be 37. Przy kilku pytaniach czekaj przez await na jedno question() po drugim.

readline question() z callbackiem

Pierwotne API, dostępne w każdej wersji Node.js, przekazuje odpowiedź do callbacku. Zagnieżdżone pytania zagnieżdżają callbacki:

// input: blue
const readline = require('readline');

const rl = readline.createInterface({
    input: process.stdin,
    output: process.stdout,
});

rl.question('Favorite color? ', (answer) => {
    console.log(`You picked ${answer.trim().toLowerCase()}.`);
    rl.close();
});

Wypisało pytanie, a potem You picked blue. Odpowiedź to zwykły string, więc przed porównaniem zrób trim: użytkownik, który wpisze spację po słowie, inaczej dostanie 'blue ', a to nie jest równe 'blue'.

Czytanie wejścia linia po linii

Żeby przetworzyć każdą linię aż do końca wejścia, przejdź po interfejsie pętlą for await. Tak program czyta listę wpisywaną przez użytkownika (zakończoną przez Ctrl+D) albo plik przekazany potokiem przez node index.js < numbers.txt. Starszy kod robi to samo przez zdarzenia, rl.on('line', fn) dla każdej linii i rl.on('close', fn) na końcu; pętla to ta para zdarzeń zapisana z góry na dół:

// input: 12
// input: 7
// input: 30
const readline = require('readline');

async function main() {
    const rl = readline.createInterface({ input: process.stdin });
    let total = 0;
    let count = 0;

    for await (const line of rl) {
        total += Number(line);
        count += 1;
    }

    console.log(`${count} numbers, total ${total}`);
}

main();

Wypisało 3 numbers, total 49, a pętla sama się skończyła, gdy skończyło się wejście, więc close() nie jest potrzebne. Dodaj czwartą linię wejścia, 1, a wynik zmieni się na 4 numbers, total 50.

Odczyt całego stdin naraz

Przy wejściu przekazanym potokiem z innego programu (cat data.txt | node index.js) prościej jest wczytać wszystko jednym wywołaniem. Deskryptor pliku 0 to standardowe wejście. Plik zapisany w Windows może kończyć linie przez \r\n, więc dziel po /\r?\n/, gdy wejście może stamtąd pochodzić:

// input: apples 3
// input: bread 1
// input: cheese 2
const fs = require('fs');

const text = fs.readFileSync(0, 'utf8');
const lines = text.trim().split(/\r?\n/);

for (const line of lines) {
    const [item, qty] = line.split(' ');
    console.log(item.padEnd(8), 'x', qty);
}

Wypisało trzy produkty w kolumnie. readFileSync(0) blokuje, dopóki wejście nie jest kompletne, co jest w porządku dla skryptu czytającego potok i dla testów, ale źle sprawdza się w narzędziu interaktywnym, gdzie użytkownik musiałby wpisać wszystko, zanim zobaczy jakiekolwiek pytanie.

Którego użyć

Wszystkie cztery czytają to samo standardowe wejście. Różnią się tym, kiedy twój kod dostaje tekst: po jednej odpowiedzi, po jednej linii albo wszystko na końcu.

Częste błędy

Zapominanie o rl.close(). Interfejs trzyma standardowe wejście otwarte, więc program po ostatnim pytaniu nigdy się nie kończy. Zamknij go, gdy masz wszystkie odpowiedzi.

Używanie odpowiedzi jako liczby. Jak wszystko wpisane w terminalu, odpowiedź to string. '36' + 1 to '361'; najpierw zamień przez Number().

Przekazywanie kilku odpowiedzi potokiem do kilku pytań. Gdy wejście przychodzi z potoku zamiast z klawiatury, readline czyta wszystko naraz, a linia, która przyjdzie przed zadaniem jej question(), przepada. Przy wejściu z potoku użyj pętli for await albo readFileSync(0).

Pomijanie opcji output. Bez output: process.stdout question() nigdy nie wypisze pytania, a użytkownik patrzy w pusty terminal. Pętla linia po linii jej nie potrzebuje, bo nic nie wypisuje.