Node.js v25.0.0 ドキュメンテーション

クラス: inspector.Session#

• 継承元: <EventEmitter>

inspector.Session は、V8 インスペクタのバックエンドにメッセージをディスパッチし、メッセージの応答と通知を受信するために使用されます。

session.on('inspectorNotification', (message) => console.log(message.method));
// Debugger.paused
// Debugger.resumed copy

session.on('Debugger.paused', ({ params }) => {
  console.log(params.hitBreakpoints);
});
// [ '/the/file/that/has/the/breakpoint.js:11:0' ] copy

import { Session } from 'node:inspector/promises';
try {
  const session = new Session();
  session.connect();
  const result = await session.post('Runtime.evaluate', { expression: '2 + 2' });
  console.log(result);
} catch (error) {
  console.error(error);
}
// Output: { result: { type: 'number', value: 4, description: '4' } } copy

import { Session } from 'node:inspector/promises';
import fs from 'node:fs';
const session = new Session();
session.connect();

await session.post('Profiler.enable');
await session.post('Profiler.start');
// Invoke business logic under measurement here...

// some time later...
const { profile } = await session.post('Profiler.stop');

// Write profile to disk, upload, etc.
fs.writeFileSync('./profile.cpuprofile', JSON.stringify(profile)); copy

import { Session } from 'node:inspector/promises';
import fs from 'node:fs';
const session = new Session();

const fd = fs.openSync('profile.heapsnapshot', 'w');

session.connect();

session.on('HeapProfiler.addHeapSnapshotChunk', (m) => {
  fs.writeSync(fd, m.params.chunk);
});

const result = await session.post('HeapProfiler.takeHeapSnapshot', null);
console.log('HeapProfiler.takeHeapSnapshot done:', result);
session.disconnect();
fs.closeSync(fd); copy

クラス: inspector.Session#

• 継承元: <EventEmitter>

inspector.Session は、V8 インスペクタのバックエンドにメッセージをディスパッチし、メッセージの応答と通知を受信するために使用されます。

session.on('inspectorNotification', (message) => console.log(message.method));
// Debugger.paused
// Debugger.resumed copy

session.on('Debugger.paused', ({ params }) => {
  console.log(params.hitBreakpoints);
});
// [ '/the/file/that/has/the/breakpoint.js:11:0' ] copy

session.post('Runtime.evaluate', { expression: '2 + 2' },
             (error, { result }) => console.log(result));
// Output: { type: 'number', value: 4, description: '4' } copy

const inspector = require('node:inspector');
const fs = require('node:fs');
const session = new inspector.Session();
session.connect();

session.post('Profiler.enable', () => {
  session.post('Profiler.start', () => {
    // Invoke business logic under measurement here...

    // some time later...
    session.post('Profiler.stop', (err, { profile }) => {
      // Write profile to disk, upload, etc.
      if (!err) {
        fs.writeFileSync('./profile.cpuprofile', JSON.stringify(profile));
      }
    });
  });
}); copy

const inspector = require('node:inspector');
const fs = require('node:fs');
const session = new inspector.Session();

const fd = fs.openSync('profile.heapsnapshot', 'w');

session.connect();

session.on('HeapProfiler.addHeapSnapshotChunk', (m) => {
  fs.writeSync(fd, m.params.chunk);
});

session.post('HeapProfiler.takeHeapSnapshot', null, (err, r) => {
  console.log('HeapProfiler.takeHeapSnapshot done:', err, r);
  session.disconnect();
  fs.closeSync(fd);
}); copy

inspector.close()#

残りのすべての接続を閉じようと試み、すべてが閉じるまでイベントループをブロックします。すべての接続が閉じられると、インスペクタを非アクティブ化します。

inspector.console#

• 型: <Object> リモートのインスペクタコンソールにメッセージを送信するためのオブジェクト。

require('node:inspector').console.log('a message'); copy

インスペクタコンソールは、Node.js コンソールと API のパリティを持っていません。

inspector.open([port[, host[, wait]]])#

• port <number> インスペクタ接続をリッスンするポート。オプショナル。デフォルト: CLI で指定されたもの。
• host <string> インスペクタ接続をリッスンするホスト。オプショナル。デフォルト: CLI で指定されたもの。
• wait <boolean> クライアントが接続するまでブロックします。オプショナル。デフォルト: false。
• 戻り値: <Disposable> inspector.close() を呼び出す Disposable。

ホストとポートでインスペクタを有効にします。node --inspect=[[host:]port] と同等ですが、Node が起動した後にプログラム的に実行できます。

wait が true の場合、クライアントがインスペクトポートに接続し、フロー制御がデバッガクライアントに渡されるまでブロックします。

host パラメータの使用に関するセキュリティ警告を参照してください。

inspector.url()#

• 戻り値: <string> | <undefined>

アクティブなインスペクタの URL を返すか、存在しない場合は undefined を返します。

$ node --inspect -p 'inspector.url()'
Debugger listening on ws://127.0.0.1:9229/166e272e-7a30-4d09-97ce-f1c012b43c34
For help, see: https://node.dokyumento.jp/en/docs/inspector
ws://127.0.0.1:9229/166e272e-7a30-4d09-97ce-f1c012b43c34

$ node --inspect=localhost:3000 -p 'inspector.url()'
Debugger listening on ws://:3000/51cf8d0e-3c36-4c59-8efd-54519839e56a
For help, see: https://node.dokyumento.jp/en/docs/inspector
ws://:3000/51cf8d0e-3c36-4c59-8efd-54519839e56a

$ node -p 'inspector.url()'
undefined copy

inspector.waitForDebugger()#

クライアント（既存または後で接続されたもの）が Runtime.runIfWaitingForDebugger コマンドを送信するまでブロックします。

アクティブなインスペクタがない場合、例外がスローされます。

inspector.Network.dataReceived([params])#

• params <Object>

この機能は --experimental-network-inspection フラグが有効な場合のみ利用可能です。

Network.dataReceived イベントを接続されたフロントエンドにブロードキャストするか、指定されたリクエストに対して Network.streamResourceContent コマンドがまだ呼び出されていない場合はデータをバッファリングします。

また、レスポンスデータを取得するために Network.getResponseBody コマンドを有効にします。

inspector.Network.dataSent([params])#

• params <Object>

この機能は --experimental-network-inspection フラグが有効な場合のみ利用可能です。

リクエストデータを取得するために Network.getRequestPostData コマンドを有効にします。

inspector.Network.requestWillBeSent([params])#

• params <Object>

この機能は --experimental-network-inspection フラグが有効な場合のみ利用可能です。

Network.requestWillBeSent イベントを接続されたフロントエンドにブロードキャストします。このイベントは、アプリケーションが HTTP リクエストを送信しようとしていることを示します。

inspector.Network.responseReceived([params])#

• params <Object>

この機能は --experimental-network-inspection フラグが有効な場合のみ利用可能です。

Network.responseReceived イベントを接続されたフロントエンドにブロードキャストします。このイベントは、HTTP レスポンスが利用可能であることを示します。

inspector.Network.loadingFinished([params])#

• params <Object>

この機能は --experimental-network-inspection フラグが有効な場合のみ利用可能です。

Network.loadingFinished イベントを接続されたフロントエンドにブロードキャストします。このイベントは、HTTP リクエストの読み込みが完了したことを示します。

inspector.Network.loadingFailed([params])#

• params <Object>

この機能は --experimental-network-inspection フラグが有効な場合のみ利用可能です。

Network.loadingFailed イベントを接続されたフロントエンドにブロードキャストします。このイベントは、HTTP リクエストの読み込みに失敗したことを示します。

inspector.Network.webSocketCreated([params])#

• params <Object>

この機能は --experimental-network-inspection フラグが有効な場合のみ利用可能です。

Network.webSocketCreated イベントを接続されたフロントエンドにブロードキャストします。このイベントは、WebSocket 接続が開始されたことを示します。

inspector.Network.webSocketHandshakeResponseReceived([params])#

• params <Object>

この機能は --experimental-network-inspection フラグが有効な場合のみ利用可能です。

Network.webSocketHandshakeResponseReceived イベントを接続されたフロントエンドにブロードキャストします。このイベントは、WebSocket のハンドシェイク応答が受信されたことを示します。

inspector.Network.webSocketClosed([params])#

• params <Object>

この機能は --experimental-network-inspection フラグが有効な場合のみ利用可能です。

Network.webSocketClosed イベントを接続されたフロントエンドにブロードキャストします。このイベントは、WebSocket 接続が閉じられたことを示します。

inspector.NetworkResources.put#

この機能は --experimental-inspector-network-resource フラグが有効な場合のみ利用可能です。

inspector.NetworkResources.put メソッドは、Chrome DevTools Protocol (CDP) を介して発行された loadNetworkResource リクエストに対するレスポンスを提供するために使用されます。これは通常、ソースマップが URL で指定され、Chrome などの DevTools フロントエンドがソースマップを取得するためにリソースを要求したときにトリガーされます。

このメソッドにより、開発者はそのような CDP リクエストに応答して提供されるリソースコンテンツを事前に定義できます。

const inspector = require('node:inspector');
// By preemptively calling put to register the resource, a source map can be resolved when
// a loadNetworkResource request is made from the frontend.
async function setNetworkResources() {
  const mapUrl = 'https://:3000/dist/app.js.map';
  const tsUrl = 'https://:3000/src/app.ts';
  const distAppJsMap = await fetch(mapUrl).then((res) => res.text());
  const srcAppTs = await fetch(tsUrl).then((res) => res.text());
  inspector.NetworkResources.put(mapUrl, distAppJsMap);
  inspector.NetworkResources.put(tsUrl, srcAppTs);
};
setNetworkResources().then(() => {
  require('./dist/app');
}); copy

詳細については、公式の CDP ドキュメントを参照してください: Network.loadNetworkResource