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://nodejs.com.tw/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://nodejs.com.tw/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 協議（CDP）發出的 loadNetworkResource 請求提供響應。這通常在源對映（source map）由 URL 指定時觸發，並且 DevTools 前端（如 Chrome）請求該資源以檢索源對映。

此方法允許開發者預定義要為響應此類 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