Node.js v24.0.0 文档

new inspector.Session()#

创建 inspector.Session 类的新实例。 检查器会话需要通过 session.connect() 连接，然后才能将消息分派到检查器后端。

当使用 Session 时，控制台 API 输出的对象将不会被释放，除非我们手动执行 Runtime.DiscardConsoleEntries 命令。

事件：'inspectorNotification'#

• <Object> 通知消息对象

当接收到来自 V8 Inspector 的任何通知时触发。

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

注意 不建议使用同线程会话的断点，请参阅 支持断点。

也可以只订阅具有特定方法的通知

事件：<inspector-protocol-method>;#

• <Object> 通知消息对象

当接收到检查器通知时触发，该通知的 method 字段设置为 <inspector-protocol-method> 值。

以下代码片段在 'Debugger.paused' 事件上安装侦听器，并在程序执行暂停时（例如，通过断点）打印程序暂停的原因

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

注意 不建议使用同线程会话的断点，请参阅 支持断点。

session.connect()#

将会话连接到检查器后端。

session.connectToMainThread()#

将会话连接到主线程检查器后端。 如果未在 Worker 线程上调用此 API，则会抛出异常。

session.disconnect()#

立即关闭会话。 所有待处理的消息回调都将以错误形式调用。 需要调用 session.connect() 才能再次发送消息。 重新连接的会话将丢失所有检查器状态，例如启用的代理或配置的断点。

session.post(method[, params])#

• method <string>
• params <Object>
• 返回: <Promise>

将消息发布到检查器后端。

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

V8 检查器协议的最新版本发布在 Chrome DevTools Protocol Viewer 上。

Node.js 检查器支持 V8 声明的所有 Chrome DevTools Protocol 域。 Chrome DevTools Protocol 域提供了一个接口，用于与用于检查应用程序状态和侦听运行时事件的运行时代理之一进行交互。

用法示例#

除了调试器之外，还可以通过 DevTools 协议使用各种 V8 分析器。

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

new inspector.Session()#

创建 inspector.Session 类的新实例。 检查器会话需要通过 session.connect() 连接，然后才能将消息分派到检查器后端。

当使用 Session 时，控制台 API 输出的对象将不会被释放，除非我们手动执行 Runtime.DiscardConsoleEntries 命令。

事件：'inspectorNotification'#

• <Object> 通知消息对象

当接收到来自 V8 Inspector 的任何通知时触发。

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

注意 不建议使用同线程会话的断点，请参阅 支持断点。

也可以只订阅具有特定方法的通知

事件：<inspector-protocol-method>;#

• <Object> 通知消息对象

当接收到检查器通知时触发，该通知的 method 字段设置为 <inspector-protocol-method> 值。

以下代码片段在 'Debugger.paused' 事件上安装侦听器，并在程序执行暂停时（例如，通过断点）打印程序暂停的原因

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

注意 不建议使用同线程会话的断点，请参阅 支持断点。

session.connect()#

将会话连接到检查器后端。

session.connectToMainThread()#

将会话连接到主线程检查器后端。 如果未在 Worker 线程上调用此 API，则会抛出异常。

session.disconnect()#

立即关闭会话。 所有待处理的消息回调都将以错误形式调用。 需要调用 session.connect() 才能再次发送消息。 重新连接的会话将丢失所有检查器状态，例如启用的代理或配置的断点。

session.post(method[, params][, callback])#

• method <string>
• params <Object>
• callback <Function>

将消息发布到检查器后端。 收到响应时会通知 callback。 callback 是一个函数，它接受两个可选参数：error 和特定于消息的结果。

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

V8 检查器协议的最新版本发布在 Chrome DevTools Protocol Viewer 上。

Node.js 检查器支持 V8 声明的所有 Chrome DevTools Protocol 域。 Chrome DevTools Protocol 域提供了一个接口，用于与用于检查应用程序状态和侦听运行时事件的运行时代理之一进行交互。

当发送 HeapProfiler.takeHeapSnapshot 或 HeapProfiler.stopTrackingHeapObjects 命令到 V8 时，不能将 reportProgress 设置为 true。

用法示例#

除了调试器之外，还可以通过 DevTools 协议使用各种 V8 分析器。

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