mitmario.dev

Argumente lesen

Node.js Sandbox 3 Min Lesezeit 3 BeispieleLektion 1 von 7

Heute sollen 20 Euro umgerechnet werden, morgen 35. Jedes Mal dafür den Code aufzumachen, nervt schnell.

Ein Werkzeug bekommt gesagt, womit es arbeiten soll. Auf der Kommandozeile schreibst du den Wert einfach hinter den Dateinamen, und Node legt ihn dir hin.

Wo die Werte landen

process.argv ist ein Array aus Texten. Darin steht alles, was beim Start auf der Kommandozeile stand, in derselben Reihenfolge.

Auf Position 0 steht der Pfad zum Node-Programm selbst, hier /usr/local/bin/node. Auf Position 1 steht der absolute Pfad zu deiner Datei. Erst ab Position 2 kommt, was du selbst hingeschrieben hast.

Wegen dieser beiden vorderen Einträge siehst du in fremdem Code fast immer dieselbe Zeile.

Was wirklich in process.argv steht
const eigene = process.argv.slice(2);

console.log("Anzahl:", eigene.length);
console.log("Als Liste:", eigene);
console.log("Das erste:", eigene[0]);

Gestartet wird das Beispiel mit node argumente.mjs 42 --einheit=km. slice(2) schneidet die zwei Einträge weg, die dich nicht interessieren. Übrig bleibt, was beim Aufruf mitgegeben wurde, nämlich [ '42', '--einheit=km' ].

Mit einem anderen Aufruf ändert sich die Ausgabe. Bei node argumente.mjs Hallo Welt steht da Anzahl: 2 und darunter die beiden Wörter. Ohne Argumente sind es null, und so sieht es auch später aus, wenn jemand dein Werkzeug zum ersten Mal benutzt und dabei schlicht vergisst, etwas hinter den Dateinamen zu schreiben.

Alles ist Text, auch die Zahl

Der Fehler an dieser Stelle ist besonders unangenehm, weil nichts abstürzt.

Wenn die Zahl gar keine ist
const zahl = process.argv[2];

console.log("Typ:", typeof zahl);
console.log("Mal zwei:", zahl * 2);
console.log("Plus zwei:", zahl + 2);
console.log("Erst umwandeln:", Number(zahl) + 2);

Mit einer 20 als Argument ergibt zahl * 2 40, wie erwartet. zahl + 2 ergibt 202.

Mit * kann man bei Texten nichts Sinnvolles anfangen, also wandelt JavaScript still in eine Zahl um. Bei + gibt es eine Bedeutung für Texte, nämlich Aneinanderhängen, und die gewinnt. Aus "20" und 2 wird "202".

Gemein ist, dass die Multiplikation funktioniert. Du testest kurz, es passt, und drei Wochen später zählt dein Programm irgendwo zusammen und liefert Unsinn.

Ich wandle jedes Argument, das eine Zahl sein soll, sofort mit Number(text) um und frage mit Number.isNaN(wert), ob etwas Brauchbares herauskam.

Positionsargumente und benannte Argumente

Einem Programm kann man auf zwei Arten etwas mitgeben. Sie fühlen sich verschieden an.

Ein Positionsargument steht einfach da: node umrechnen.mjs 42. Was es bedeutet, ergibt sich aus seiner Stelle. Das ist knapp und liest sich gut, solange es ein oder zwei sind. Bei fünf weiß niemand mehr, was an dritter Stelle stand.

Ein benanntes Argument sagt es selbst: node umrechnen.mjs --einheit=km. Länger zu tippen, dafür lesbar. Und die Reihenfolge ist egal.

Für die benannte Variante hat Node einen eingebauten Weg, und den nehme ich, bevor ich dafür ein Paket installiere.

Benannte Argumente mit parseArgs
import { parseArgs } from "node:util";

const { values, positionals } = parseArgs({
  options: {
    einheit: { type: "string", default: "EUR" },
    ausfuehrlich: { type: "boolean", short: "a", default: false },
  },
  allowPositionals: true,
});

console.log("Einheit:", values.einheit);
console.log("Ausführlich:", values.ausfuehrlich);
console.log("Übrig:", positionals);

Hier lautet der Aufruf node lesen.mjs --einheit=km -a 12 34, also eine benannte Option, eine Kurzform und zwei Werte hinterher. parseArgs aus node:util bekommt eine Beschreibung deiner Optionen. Zurück kommen zwei Dinge, values mit den benannten Werten und positionals mit dem Rest, hier [ '12', '34' ]. Kurzformen wie -a kennt es, Standardwerte auch, und wenn jemand eine Option angibt, die es nicht gibt, meldet es einen Fehler.

Für Werkzeuge wie die in diesem Abschnitt reicht das. Ein Paket lohnt sich erst, wenn du Unterbefehle, automatisch erzeugte Hilfetexte oder mehrsprachige Fehlermeldungen brauchst.

Was tun, wenn ein Argument fehlt

Fehlt einem Werkzeug ein Pflichtargument, sagt es in einer Zeile, wie es benutzt wird, und hört auf.

Mit undefined weiterzurechnen ist der schlechtere Weg. Entweder kommt NaN heraus und wandert dann durch dein halbes Programm. Oder es stürzt an einer Stelle ab, die mit dem eigentlichen Problem nichts zu tun hat.

Die Aufrufhilfe gehört auf den Fehlerkanal, und das Programm endet mit einer Zahl, die Misserfolg bedeutet. Dafür reichen console.error und process.exit(1) aus Lektion 3.5, und in Lektion 4.3 geht es um beide genauer.

Der Umrechner im Reiter Praxis bekommt Betrag und Kurs als Argumente.

Zum Mitnehmen

process.argv beginnt mit dem Pfad zu Node und dem zu deiner Datei, deine eigenen Werte stehen ab Index 2. Jeder davon ist Text, auch eine Zahl, und für benannte Optionen gibt es parseArgs aus node:util.

Jetzt du

Basis Konto, kostenlos

Zu dieser Lektion gehört eine Aufgabe. Du schreibst den Code selbst, und nach jedem Lauf sagt dir eine Prüfliste, was schon stimmt.

Dafür brauchst du das Basis Konto. Es kostet nichts, und ein Passwort gibt es auch nicht.

In diesem Kurs läuft dein Code auf einem Server. Dafür hat das Basis Konto 1 Stunde im Monat, mehr Zeit gibt es mit dem Premium Konto.

Was in dieser Lektion steckt

  • Artikel mit 3 Beispielen zum Ausprobieren

    Steht hier, ohne Konto lesbar.

  • Aufgabe, dein Code läuft auf einem Server

    Öffnet sich mit dem Basis Konto.