Класс: 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

API консоли инспектора не полностью соответствует API консоли Node.js.

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

• port <number> Порт для прослушивания соединений инспектора. Необязательный параметр. По умолчанию: значение, указанное в командной строке.
• host <string> Хост для прослушивания соединений инспектора. Необязательный параметр. По умолчанию: значение, указанное в командной строке.
• wait <boolean> Блокировать выполнение до подключения клиента. Необязательный параметр. По умолчанию: false.
• Возвращает: <Disposable> Объект Disposable, вызывающий inspector.close().

Активирует инспектор на указанном хосте и порте. Эквивалентно node --inspect=[[host:]port], но может быть выполнено программно после запуска Node.js.

Если 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.org/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://localhost:3000/51cf8d0e-3c36-4c59-8efd-54519839e56a
For help, see: https://nodejs.org/en/docs/inspector
ws://localhost: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 используется для предоставления ответа на запрос loadNetworkResource, отправленный через протокол Chrome DevTools (CDP). Обычно это происходит, когда карта исходного кода указана 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 = 'http://localhost:3000/dist/app.js.map';
  const tsUrl = 'http://localhost: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