function

v8.startHeapProfile

Starting a heap profile then return a SyncHeapProfileHandle object. This API supports using syntax.

import v8 from 'node:v8';

const handle = v8.startHeapProfile();
const profile = handle.stop();
console.log(profile);

With custom parameters:

import v8 from 'node:v8';

const handle = v8.startHeapProfile({
  sampleInterval: 1024,
  stackDepth: 8,
  forceGC: true,
  includeObjectsCollectedByMajorGC: true,
});
const profile = handle.stop();
console.log(profile);

Referenced types

interface HeapProfileOptions

forceGC?: boolean
Force garbage collection before taking the profile. Default: false.
includeObjectsCollectedByMajorGC?: boolean
Include objects collected by major GC. Default: false.
includeObjectsCollectedByMinorGC?: boolean
Include objects collected by minor GC. Default: false.
sampleInterval?: number
The average sampling interval in bytes. Default: 524288 (512 KiB).
stackDepth?: number
The maximum stack depth for samples. Default: 16.

interface SyncHeapProfileHandle

[Symbol.dispose](): void;
Stopping collecting the profile and the profile will be discarded.
stop(): string;
Stopping collecting the profile and return the profile data.