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.org.cn/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.org.cn/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