debug-js/debug

これは何？

主な機能

• 01DEBUG環境変数で切り替えられる、名前空間付きのデバッグ関数。
• 02出力を絞り込むためのワイルドカードと除外パターン。
• 03Node.jsとWebブラウザーで動作し、対応環境では色分け表示。
• 04呼び出し間のミリ秒単位の経過時間表示。TTY以外への出力ではISO形式のタイムスタンプを表示。
• 05独自のフォーマッターにも対応したprintf形式のフォーマッター。
• 06実行時に出力を有効化・無効化し、名前空間を拡張するAPI。

ユースケース

• Node.jsのライブラリやアプリケーションに、通常時は余計な出力を出さず、必要なときだけ有効にできるデバッグログを追加する。
• サーバープロセスで名前空間ごとにリクエスト処理やワーカーの動作を追跡する。
• localStorage.debugを設定して、ブラウザー上でフロントエンドのコードをデバッグする。

クイックスタート

1. 1

   npmでパッケージをインストールします

   npm install debug
2. 2

   コード内で名前空間を指定してdebugインスタンスを作成し、DEBUGを有効にしてアプリを実行します（macOS/Linux）

   DEBUG=* node app.js

使う前に知っておきたいこと

• !Debugの出力は、DEBUG環境変数またはlocalStorage.debugで有効にした名前空間のみ表示されます。
• !Node.jsでパレットの全色を使うには、オプションのsupports-colorモジュールが必要です。

収録されている特集

トピック

よくある質問

debug とは？

DEBUG環境変数で有効化でき、Node.jsとWebブラウザーで名前空間付きのデバッグ出力を行う、小さなJavaScriptユーティリティです。 debugは、Node.jsのコアで使われているデバッグ手法をもとにした、小さなJavaScript用ロギングユーティリティです。'http'や'worker:a'などの名前空間を指定してdebug関数を作成し、その名前空間がDEBUG環境変数で有効になっている場合にのみ出力します。DEBUG=connect:*やDEBUG=*,-connect:*のようなワイルドカードや除外指定を使えば、アプリケーション内の特定の部分に出力を絞れます。

debug は無料で使えますか？ライセンスは？

debug は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

debug は今もメンテナンスされていますか？

活発にメンテナンス中。debug の最終コミットは 2026年10月14日 です。

debug は何に使えますか？

Node.jsのライブラリやアプリケーションに、通常時は余計な出力を出さず、必要なときだけ有効にできるデバッグログを追加する。 サーバープロセスで名前空間ごとにリクエスト処理やワーカーの動作を追跡する。 localStorage.debugを設定して、ブラウザー上でフロントエンドのコードをデバッグする。

debug のインストール方法は？

npmでパッケージをインストールします: npm install debug コード内で名前空間を指定してdebugインスタンスを作成し、DEBUGを有効にしてアプリを実行します（macOS/Linux）: DEBUG=* node app.js

debug はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/debug-js/debug