Node.js readline: Benutzereingaben im Terminal lesen

Um in Node.js Benutzereingaben zu lesen, erstellst du ein readline-Interface auf process.stdin und fragst mit rl.question(). Node.js hat kein prompt(): Die Browservariante öffnet einen Dialog, und ein Terminalprogramm hat keinen. Die moderne Form nutzt readline/promises, wo await rl.question('Name? ') die Zeile zurückgibt, die der Nutzer eingegeben hat. Schließ das Interface, wenn du fertig bist, sonst wartet das Programm weiter auf Eingaben.

// 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() hat seinen Prompt ausgegeben, auf eine Eingabezeile gewartet und sie ohne Zeilenumbruch zurückgegeben, deshalb hat das Programm Next year you will be 37. ausgegeben. Für mehrere Fragen wartest du mit await auf ein question() nach dem anderen.

readline question() mit Callback

Die ursprüngliche API, in jeder Node.js-Version, übergibt die Antwort an einen Callback. Verschachtelte Fragen verschachteln Callbacks:

// 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();
});

Es hat den Prompt ausgegeben, dann You picked blue. Die Antwort ist ein einfacher String, trimm sie also vor dem Vergleichen: Ein Nutzer, der nach dem Wort ein Leerzeichen tippt, bekommt sonst 'blue ', und das ist nicht gleich 'blue'.

Eingaben zeilenweise lesen

Um jede Zeile zu verarbeiten, bis die Eingabe endet, durchläufst du das Interface mit for await. So liest ein Programm eine Liste, die der Nutzer eintippt (beendet mit Ctrl+D), oder eine Datei, die mit node index.js < numbers.txt hineingepipt wird. Älterer Code macht dasselbe mit Events, rl.on('line', fn) für jede Zeile und rl.on('close', fn) am Ende; die Schleife ist dieses Event-Paar von oben nach unten geschrieben:

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

Es hat 3 numbers, total 49 ausgegeben, und die Schleife hat von selbst aufgehört, als die Eingabe endete, ein close() ist also nicht nötig. Füg eine vierte Eingabezeile hinzu, 1, und das Ergebnis wird zu 4 numbers, total 50.

Die ganze Standardeingabe auf einmal lesen

Für Eingaben, die aus einem anderen Programm kommen (cat data.txt | node index.js), ist es einfacher, alles mit einem Aufruf zu lesen. File Descriptor 0 ist die Standardeingabe. Eine unter Windows gespeicherte Datei kann Zeilen mit \r\n beenden, teil also an /\r?\n/, wenn die Eingabe von dort kommen kann:

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

Es hat die drei Artikel in einer Spalte ausgegeben. readFileSync(0) blockiert, bis die Eingabe vollständig ist, was für ein Skript, das eine Pipe liest, und für Tests in Ordnung ist, aber falsch für ein interaktives Tool, bei dem der Nutzer alles tippen müsste, bevor er überhaupt einen Prompt sieht.

Was du wann nimmst

Alle vier lesen dieselbe Standardeingabe. Sie unterscheiden sich darin, wann dein Code den Text bekommt: eine Antwort nach der anderen, eine Zeile nach der anderen oder alles am Ende.

Häufige Fehler

rl.close() vergessen. Das Interface hält die Standardeingabe offen, deshalb beendet sich das Programm nach der letzten Frage nie. Schließ es, sobald du jede Antwort hast.

Die Antwort als Zahl verwenden. Wie alles, was in einem Terminal getippt wird, ist die Antwort ein String. '36' + 1 ist '361'; wandle zuerst mit Number() um.

Mehrere Antworten in mehrere Fragen pipen. Wenn die Eingabe aus einer Pipe statt von einer Tastatur kommt, liest readline alles auf einmal, und eine Zeile, die ankommt, bevor ihr question() gestellt wird, geht verloren. Für gepipte Eingaben nimm die for await-Schleife oder readFileSync(0).

Die Option output weglassen. Ohne output: process.stdout gibt question() seinen Prompt nie aus, und der Nutzer starrt auf ein leeres Terminal. Die zeilenweise Schleife braucht sie nicht, weil sie nichts ausgibt.