ファイルを選択
  1. base64hub
  2. ドキュメント
  3. npm パッケージ

npm パッケージ リファレンス

base64hub は Node.js 18 以降向けの ES モジュールで、4 つの関数、TypeScript の型、b64 コマンドを備えています。依存関係はありません。

インストール

npm i base64hub        # library
npm i -g base64hub     # b64 command

パッケージは ESM 専用です。import で読み込み、CommonJS からは await import("base64hub") を使います。型定義も同梱されています。

import { encode, decode, validate, dataUri, Base64Error } from "base64hub";

encode(input, options?)

バイト列、または文字列の UTF-8 バイト列をエンコードし、文字列を返します。input には文字列、Uint8Array(Node.js の Buffer もその一種)、ArrayBuffer、任意の型付き配列のビューを渡せます。

オプション型デフォルト効果
urlbooleanfalseURLセーフなアルファベット(- と _)。
padbooleantrue= パディングを付ける。
wrapnumber0N 文字ごとに \n を入れる。末尾には入れない。76 は 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)

Base64 を Uint8Array にデコードします。空白、タブ、改行、data:...;base64, 接頭辞、パディングの欠落、両方のアルファベットを受け付けます。それ以外は Base64Error を投げ、その position は、整形後の入力における問題の文字の位置(0 始まり)です。

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
}

テキストにするには new TextDecoder().decode(bytes) を、他の Node.js API が Buffer を求めるときは Buffer.from(bytes) を使ってください。

validate(text)

例外を投げずにテキストをチェックします。decode が成功する場合にだけ有効と判定します。

validate("SGVsbG8sIGh1YiE");
// { valid: true, variant: 'either', padded: false, bytes: 11 }
validate("Zm9v!");
// { valid: false, error: "invalid character '!' at position 4" }
フィールド意味
validtrue または false。
variantstandard(+ か / がある)、url(- か _ がある)、mixed(両方)、either(どちらもない)。
padded= を含めた整形後の長さが 4 の倍数かどうか。
bytesデコード後のサイズ(バイト)。
error無効な入力のときだけ。理由を示し、decode が投げるのと同じテキスト。

dataUri(input, mime?)

data:<mime>;base64,<payload> 形式の文字列を作ります。標準アルファベットでパディング付き、折り返しはしません。mime を省略するとタイプを判定します。PNG、JPEG、GIF、WebP、PDF、SVG はシグネチャで判定し、UTF-8 テキストなら text/plain;charset=utf-8、それ以外は 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..."

b64 コマンド

npm i -g base64hub で b64 がインストールされ、npx base64hub "Hello, hub!" ならインストールせずに一度だけ実行できます。フラグ、メッセージ、終了コードは CLI リファレンス と同じです。npm 版は入力全体をメモリに読み込んでから処理します。非常に大きなファイルには Go 版を使ってください。

更新日 2026/11/22