Referenz zum npm-Paket
base64hub ist ein ES-Modul für Node.js ab Version 18 mit vier Funktionen, TypeScript-Typen und dem Befehl b64. Keine Abhängigkeiten.
Installation
npm i base64hub # library
npm i -g base64hub # b64 command
Das Paket ist reines ESM. Importieren Sie es mit import; aus CommonJS verwenden Sie await import("base64hub"). Typdefinitionen werden mitgeliefert.
import { encode, decode, validate, dataUri, Base64Error } from "base64hub";
encode(input, options?)
Kodiert Bytes oder die UTF-8-Bytes eines Strings und gibt einen String zurück. input kann ein String sein, ein Uint8Array (ein Buffer aus Node.js ist eines), ein ArrayBuffer oder eine beliebige Typed-Array-Ansicht.
| Option | Typ | Standard | Wirkung |
|---|---|---|---|
url | boolean | false | URL-sicheres Alphabet (- und _). |
pad | boolean | true | =-Padding anhängen. |
wrap | number | 0 | Nach je N Zeichen \n einfügen, keins am Ende; 76 ist MIME. |
encode("Hello, hub!"); // "SGVsbG8sIGh1YiE="
encode("Привет", { url: true, pad: false }); // "0J_RgNC40LLQtdGC"
encode("foobar", { wrap: 4 }); // "Zm9v\nYmFy"
encode(new Uint8Array([0xfb, 0xff, 0xbf])); // "+/+/"
decode(text)
Dekodiert Base64 in ein Uint8Array. Leerzeichen, Tabs und Zeilenumbrüche, ein Präfix data:...;base64,, fehlendes Padding und beide Alphabete werden akzeptiert. Alles andere wirft einen Base64Error, dessen position der 0-basierte Index des falschen Zeichens in der bereinigten Eingabe ist.
decode("+/+/"); // Uint8Array(3) [ 251, 255, 191 ]
new TextDecoder().decode(decode("SGVsbG8sIGh1YiE")); // "Hello, hub!"
try {
decode("Zm9v!");
} catch (e) {
if (e instanceof Base64Error) console.log(e.message, e.position);
// invalid character '!' at position 4 4
}
Verwenden Sie new TextDecoder().decode(bytes) für Text und Buffer.from(bytes), wenn eine andere Node.js-API einen Buffer erwartet.
validate(text)
Prüft Text, ohne zu werfen. Gültig genau dann, wenn decode gelingen würde.
validate("SGVsbG8sIGh1YiE");
// { valid: true, variant: 'either', padded: false, bytes: 11 }
validate("Zm9v!");
// { valid: false, error: "invalid character '!' at position 4" }
| Feld | Bedeutung |
|---|---|
valid | true oder false. |
variant | standard (+ oder / gefunden), url (- oder _ gefunden), mixed (beides) oder either (keins von beiden). |
padded | Die bereinigte Länge einschließlich = ist ein Vielfaches von 4. |
bytes | Dekodierte Größe in Bytes. |
error | Nur bei ungültiger Eingabe: der Grund, derselbe Text, den decode werfen würde. |
dataUri(input, mime?)
Baut einen String data:<mime>;base64,<payload>: Standardalphabet, mit Padding, nie umbrochen. Ohne mime wird der Typ erkannt: PNG, JPEG, GIF, WebP, PDF und SVG an der Signatur, text/plain;charset=utf-8 für UTF-8-Text, sonst application/octet-stream.
dataUri("Hi"); // "data:text/plain;charset=utf-8;base64,SGk="
dataUri("a,b", "text/csv"); // "data:text/csv;base64,YSxi"
import { readFile } from "node:fs/promises";
dataUri(await readFile("logo.png")); // "data:image/png;base64,iVBORw0KGgo..."
Der Befehl b64
npm i -g base64hub installiert b64, und npx base64hub "Hello, hub!" führt es einmal ohne Installation aus. Flags, Meldungen und Exit-Codes entsprechen der CLI-Referenz. Der npm-Build liest die gesamte Eingabe in den Speicher, bevor er sie verarbeitet; für sehr große Dateien nehmen Sie den Go-Build.
Aktualisiert 22.11.2026