Node.js v21.7.2 文档

v8.cachedDataVersionTag()#

• 返回: <整数>

返回一个整数，表示从 V8 版本、命令行标志和检测到的 CPU 特性派生的版本标签。这对于确定 vm.Script cachedData 缓冲区是否与该 V8 实例兼容很有用。

console.log(v8.cachedDataVersionTag()); // 3947234607
// The value returned by v8.cachedDataVersionTag() is derived from the V8
// version, command-line flags, and detected CPU features. Test that the value
// does indeed update when flags are toggled.
v8.setFlagsFromString('--allow_natives_syntax');
console.log(v8.cachedDataVersionTag()); // 183726201 copy

v8.getHeapCodeStatistics()#

• 返回: <对象>

获取堆中代码及其元数据的统计信息，请参阅 V8 GetHeapCodeAndMetadataStatistics API。返回一个具有以下属性的对象

• code_and_metadata_size <number>
• bytecode_and_metadata_size <number>
• external_script_source_size <number>
• cpu_profiler_metadata_size <number>

{
  code_and_metadata_size: 212208,
  bytecode_and_metadata_size: 161368,
  external_script_source_size: 1410794,
  cpu_profiler_metadata_size: 0,
} copy

v8.getHeapSnapshot([options])#

• options <Object>

  • exposeInternals <boolean> 如果为真，则在堆快照中公开内部信息。默认值： false。
  • exposeNumericValues <boolean> 如果为真，则在人工字段中公开数值。默认值： false。

• 返回值： <stream.Readable> 包含 V8 堆快照的可读流。

生成当前 V8 堆的快照，并返回一个可读流，该流可用于读取 JSON 序列化表示。此 JSON 流格式旨在与 Chrome DevTools 等工具一起使用。JSON 模式未记录，并且特定于 V8 引擎。因此，模式可能会在 V8 的不同版本之间发生变化。

创建堆快照需要大约两倍于快照创建时堆大小的内存。这会导致 OOM 杀手终止进程的风险。

生成快照是一个同步操作，它会阻塞事件循环，阻塞时间取决于堆大小。

// Print heap snapshot to the console
const v8 = require('node:v8');
const stream = v8.getHeapSnapshot();
stream.pipe(process.stdout); copy

v8.getHeapSpaceStatistics()#

• 返回值： <Object[]>

返回有关 V8 堆空间的统计信息，即构成 V8 堆的段。堆空间的顺序和可用性无法保证，因为统计信息是通过 V8 GetHeapSpaceStatistics 函数提供的，并且可能会在 V8 的不同版本之间发生变化。

返回值是一个包含以下属性的对象数组

• space_name <string>
• space_size <number>
• space_used_size <number>
• space_available_size <number>
• physical_space_size <number>

[
  {
    "space_name": "new_space",
    "space_size": 2063872,
    "space_used_size": 951112,
    "space_available_size": 80824,
    "physical_space_size": 2063872
  },
  {
    "space_name": "old_space",
    "space_size": 3090560,
    "space_used_size": 2493792,
    "space_available_size": 0,
    "physical_space_size": 3090560
  },
  {
    "space_name": "code_space",
    "space_size": 1260160,
    "space_used_size": 644256,
    "space_available_size": 960,
    "physical_space_size": 1260160
  },
  {
    "space_name": "map_space",
    "space_size": 1094160,
    "space_used_size": 201608,
    "space_available_size": 0,
    "physical_space_size": 1094160
  },
  {
    "space_name": "large_object_space",
    "space_size": 0,
    "space_used_size": 0,
    "space_available_size": 1490980608,
    "physical_space_size": 0
  }
] copy

v8.getHeapStatistics()#

• 返回: <对象>

返回一个包含以下属性的对象

• total_heap_size <number>
• total_heap_size_executable <number>
• total_physical_size <number>
• total_available_size <number>
• used_heap_size <number>
• heap_size_limit <number>
• malloced_memory <number>
• peak_malloced_memory <number>
• does_zap_garbage <number>
• number_of_native_contexts <number>
• number_of_detached_contexts <number>
• total_global_handles_size <number>
• used_global_handles_size <number>
• external_memory <number>

does_zap_garbage 是一个 0/1 布尔值，表示 --zap_code_space 选项是否启用。这使得 V8 用位模式覆盖堆垃圾。RSS 占用空间（驻留集大小）会变大，因为它会持续接触所有堆页面，这使得它们不太可能被操作系统交换出去。

number_of_native_contexts 当前活动顶级上下文的数量。如果此值随时间推移而增加，则表明存在内存泄漏。

number_of_detached_contexts 已分离但尚未被垃圾回收的上下文数量。如果此值不为零，则表明存在潜在的内存泄漏。

total_global_handles_size V8 全局句柄的总内存大小。

used_global_handles_size V8 全局句柄的已用内存大小。

external_memory 数组缓冲区和外部字符串的内存大小。

{
  total_heap_size: 7326976,
  total_heap_size_executable: 4194304,
  total_physical_size: 7326976,
  total_available_size: 1152656,
  used_heap_size: 3476208,
  heap_size_limit: 1535115264,
  malloced_memory: 16384,
  peak_malloced_memory: 1127496,
  does_zap_garbage: 0,
  number_of_native_contexts: 1,
  number_of_detached_contexts: 0,
  total_global_handles_size: 8192,
  used_global_handles_size: 3296,
  external_memory: 318824
} copy

v8.setFlagsFromString(flags)#

• flags <string>

v8.setFlagsFromString() 方法可用于以编程方式设置 V8 命令行标志。使用此方法时应谨慎。在 VM 启动后更改设置可能会导致不可预测的行为，包括崩溃和数据丢失；或者可能根本不起作用。

要确定 Node.js 版本可用的 V8 选项，请运行 node --v8-options。

用法

// Print GC events to stdout for one minute.
const v8 = require('node:v8');
v8.setFlagsFromString('--trace_gc');
setTimeout(() => { v8.setFlagsFromString('--notrace_gc'); }, 60e3); copy

v8.stopCoverage()#

v8.stopCoverage() 方法允许用户停止由 NODE_V8_COVERAGE 启动的覆盖率收集，以便 V8 可以释放执行计数记录并优化代码。如果用户想要按需收集覆盖率，则可以将其与 v8.takeCoverage() 结合使用。

v8.takeCoverage()#

v8.takeCoverage() 方法允许用户按需将由 NODE_V8_COVERAGE 启动的覆盖率写入磁盘。此方法可以在进程生命周期内多次调用。每次调用时，执行计数器将被重置，并将新的覆盖率报告写入由 NODE_V8_COVERAGE 指定的目录。

当进程即将退出时，除非在进程退出之前调用 v8.stopCoverage()，否则仍会将最后一个覆盖率写入磁盘。

v8.writeHeapSnapshot([filename[,options]])#

• filename <string> 要保存 V8 堆快照的文件路径。如果未指定，将生成一个具有模式 'Heap-${yyyymmdd}-${hhmmss}-${pid}-${thread_id}.heapsnapshot' 的文件名，其中 {pid} 将是 Node.js 进程的 PID，{thread_id} 将是 0（当从主 Node.js 线程调用 writeHeapSnapshot() 时）或工作线程的 ID。
• options <Object>
  • exposeInternals <boolean> 如果为真，则在堆快照中公开内部信息。默认值： false。
  • exposeNumericValues <boolean> 如果为真，则在人工字段中公开数值。默认值： false。
• 返回值：<string> 保存快照的文件名。

生成当前 V8 堆的快照并将其写入 JSON 文件。此文件旨在与 Chrome DevTools 等工具一起使用。JSON 架构未记录，特定于 V8 引擎，并且可能会在 V8 的不同版本之间发生变化。

堆快照特定于单个 V8 隔离。使用 工作线程 时，从主线程生成的堆快照将不包含有关工作线程的任何信息，反之亦然。

创建堆快照需要大约两倍于快照创建时堆大小的内存。这会导致 OOM 杀手终止进程的风险。

生成快照是一个同步操作，它会阻塞事件循环，阻塞时间取决于堆大小。

const { writeHeapSnapshot } = require('node:v8');
const {
  Worker,
  isMainThread,
  parentPort,
} = require('node:worker_threads');

if (isMainThread) {
  const worker = new Worker(__filename);

  worker.once('message', (filename) => {
    console.log(`worker heapdump: ${filename}`);
    // Now get a heapdump for the main thread.
    console.log(`main thread heapdump: ${writeHeapSnapshot()}`);
  });

  // Tell the worker to create a heapdump.
  worker.postMessage('heapdump');
} else {
  parentPort.once('message', (message) => {
    if (message === 'heapdump') {
      // Generate a heapdump for the worker
      // and return the filename to the parent.
      parentPort.postMessage(writeHeapSnapshot());
    }
  });
} copy

v8.setHeapSnapshotNearHeapLimit(limit)#

• limit <integer>

如果从命令行已设置 --heapsnapshot-near-heap-limit 或 API 被调用多次，则 API 将是无操作的。limit 必须是正整数。有关更多信息，请参见 --heapsnapshot-near-heap-limit。

序列化 API#

序列化 API 提供了一种以与 HTML 结构化克隆算法 兼容的方式序列化 JavaScript 值的方法。

该格式向后兼容（即安全存储到磁盘）。相等的 JavaScript 值可能会导致不同的序列化输出。

v8.serialize(value)#

• value <any>
• 返回值：<Buffer>

使用 DefaultSerializer 将 value 序列化为缓冲区。

当尝试序列化需要大于 buffer.constants.MAX_LENGTH 的缓冲区的巨大对象时，将抛出 ERR_BUFFER_TOO_LARGE。

v8.deserialize(buffer)#

• buffer <Buffer> | <TypedArray> | <DataView> 由 serialize() 返回的缓冲区。

使用具有默认选项的 DefaultDeserializer 从缓冲区读取 JS 值。

类: v8.Serializer#

new Serializer()#

创建一个新的 Serializer 对象。

serializer.writeHeader()#

写入一个头，其中包含序列化格式版本。

serializer.writeValue(value)#

• value <any>

序列化 JavaScript 值并将序列化表示添加到内部缓冲区。

如果 value 无法序列化，则会抛出错误。

serializer.releaseBuffer()#

• 返回值：<Buffer>

返回存储的内部缓冲区。释放缓冲区后，不应使用此序列化器。如果之前的写入失败，则调用此方法会导致未定义的行为。

serializer.transferArrayBuffer(id, arrayBuffer)#

• id <integer> 一个 32 位无符号整数。
• arrayBuffer <ArrayBuffer> 一个 ArrayBuffer 实例。

将 ArrayBuffer 标记为已将其内容从带外传输。在反序列化上下文中将相应的 ArrayBuffer 传递给 deserializer.transferArrayBuffer()。

serializer.writeUint32(value)#

• value <integer>

写入一个原始的 32 位无符号整数。用于自定义的 serializer._writeHostObject() 内部。

serializer.writeUint64(hi, lo)#

• hi <整数>
• lo <整数>

写入一个原始的 64 位无符号整数，拆分为高位和低位 32 位部分。用于自定义的 serializer._writeHostObject() 内部。

serializer.writeDouble(value)#

• value <数字>

写入一个 JS number 值。用于自定义的 serializer._writeHostObject() 内部。

serializer.writeRawBytes(buffer)#

• buffer <Buffer> | <TypedArray> | <DataView>

将原始字节写入序列化器内部缓冲区。反序列化器将需要一种方法来计算缓冲区的长度。用于自定义的 serializer._writeHostObject() 内部。

serializer._writeHostObject(object)#

• object <对象>

此方法用于写入某种宿主对象，即由原生 C++ 绑定创建的对象。如果无法序列化 object，则应抛出合适的异常。

此方法不在 Serializer 类本身中，但可以由子类提供。

serializer._getDataCloneError(message)#

• message <字符串>

此方法用于生成当对象无法克隆时将抛出的错误对象。

此方法默认为 Error 构造函数，可以在子类中重写。

serializer._getSharedArrayBufferId(sharedArrayBuffer)#

• sharedArrayBuffer <SharedArrayBuffer>

当序列化器要序列化一个 SharedArrayBuffer 对象时，会调用此方法。它必须返回一个无符号的 32 位整数 ID，用于标识该对象，如果该 SharedArrayBuffer 已经序列化过，则使用相同的 ID。反序列化时，此 ID 将传递给 deserializer.transferArrayBuffer()。

如果对象无法序列化，则应抛出异常。

此方法不在 Serializer 类本身中，但可以由子类提供。

serializer._setTreatArrayBufferViewsAsHostObjects(flag)#

• flag <boolean> 默认值： false

指示是否将 TypedArray 和 DataView 对象视为宿主对象，即将其传递给 serializer._writeHostObject().

类：v8.Deserializer#

new Deserializer(buffer)#

• buffer <Buffer> | <TypedArray> | <DataView> 由 serializer.releaseBuffer() 返回的缓冲区。

创建一个新的 Deserializer 对象。

deserializer.readHeader()#

读取并验证标头（包括格式版本）。例如，可能会拒绝无效或不支持的线格式。在这种情况下，将抛出 Error。

deserializer.readValue()#

从缓冲区反序列化 JavaScript 值并返回它。

deserializer.transferArrayBuffer(id, arrayBuffer)#

• id <integer> 一个 32 位无符号整数。
• arrayBuffer <ArrayBuffer> | <SharedArrayBuffer> 一个 ArrayBuffer 实例。

将 ArrayBuffer 标记为其内容已通过带外传输。将序列化上下文中相应的 ArrayBuffer 传递给 serializer.transferArrayBuffer()（或在 SharedArrayBuffer 的情况下从 serializer._getSharedArrayBufferId() 返回 id）。

deserializer.getWireFormatVersion()#

• 返回: <整数>

读取底层线格式版本。可能主要对读取旧线格式版本的遗留代码有用。可能在 .readHeader() 之前不被调用。

deserializer.readUint32()#

• 返回: <整数>

读取一个原始的 32 位无符号整数并返回它。用于自定义的 deserializer._readHostObject() 内部。

deserializer.readUint64()#

• 返回值: <integer[]>

读取一个原始的 64 位无符号整数，并将其作为包含两个 32 位无符号整数条目的数组 [hi, lo] 返回。用于自定义的 deserializer._readHostObject() 内部。

deserializer.readDouble()#

• 返回值: <number>

读取一个 JS number 值。用于自定义的 deserializer._readHostObject() 内部。

deserializer.readRawBytes(length)#

• length <integer>
• 返回值：<Buffer>

从反序列化器的内部缓冲区读取原始字节。length 参数必须与传递给 serializer.writeRawBytes() 的缓冲区长度相对应。用于自定义的 deserializer._readHostObject() 内部。

deserializer._readHostObject()#

此方法用于读取某种宿主对象，即由原生 C++ 绑定创建的对象。如果无法反序列化数据，则应抛出合适的异常。

此方法不在 Deserializer 类本身中，但可以由子类提供。

类: v8.DefaultSerializer#

Serializer 的子类，它将 TypedArray（特别是 Buffer）和 DataView 对象序列化为宿主对象，并且只存储它们所引用的底层 ArrayBuffer 的一部分。

类: v8.DefaultDeserializer#

一个 Deserializer 的子类，对应于 DefaultSerializer 写入的格式。

Promise 钩子#

promiseHooks 接口可用于跟踪 Promise 生命周期事件。要跟踪所有异步活动，请参见 async_hooks，它在内部使用此模块来生成 Promise 生命周期事件以及其他异步资源的事件。对于请求上下文管理，请参见 AsyncLocalStorage。

import { promiseHooks } from 'node:v8';

// There are four lifecycle events produced by promises:

// The `init` event represents the creation of a promise. This could be a
// direct creation such as with `new Promise(...)` or a continuation such
// as `then()` or `catch()`. It also happens whenever an async function is
// called or does an `await`. If a continuation promise is created, the
// `parent` will be the promise it is a continuation from.
function init(promise, parent) {
  console.log('a promise was created', { promise, parent });
}

// The `settled` event happens when a promise receives a resolution or
// rejection value. This may happen synchronously such as when using
// `Promise.resolve()` on non-promise input.
function settled(promise) {
  console.log('a promise resolved or rejected', { promise });
}

// The `before` event runs immediately before a `then()` or `catch()` handler
// runs or an `await` resumes execution.
function before(promise) {
  console.log('a promise is about to call a then handler', { promise });
}

// The `after` event runs immediately after a `then()` handler runs or when
// an `await` begins after resuming from another.
function after(promise) {
  console.log('a promise is done calling a then handler', { promise });
}

// Lifecycle hooks may be started and stopped individually
const stopWatchingInits = promiseHooks.onInit(init);
const stopWatchingSettleds = promiseHooks.onSettled(settled);
const stopWatchingBefores = promiseHooks.onBefore(before);
const stopWatchingAfters = promiseHooks.onAfter(after);

// Or they may be started and stopped in groups
const stopHookSet = promiseHooks.createHook({
  init,
  settled,
  before,
  after,
});

// To stop a hook, call the function returned at its creation.
stopWatchingInits();
stopWatchingSettleds();
stopWatchingBefores();
stopWatchingAfters();
stopHookSet(); copy

promiseHooks.onInit(init)#

• init <Function> 当创建 Promise 时要调用的 init 回调。
• 返回: <Function> 停止钩子的调用。

init 钩子必须是一个普通函数。提供异步函数将抛出异常，因为它会导致无限微任务循环。

import { promiseHooks } from 'node:v8';

const stop = promiseHooks.onInit((promise, parent) => {});const { promiseHooks } = require('node:v8');

const stop = promiseHooks.onInit((promise, parent) => {});copy

promiseHooks.onSettled(settled)#

• settled <Function> 当 Promise 解决或拒绝时要调用的 settled 回调。
• 返回: <Function> 停止钩子的调用。

settled 钩子必须是一个普通函数。提供异步函数将抛出异常，因为它会导致无限微任务循环。

import { promiseHooks } from 'node:v8';

const stop = promiseHooks.onSettled((promise) => {});const { promiseHooks } = require('node:v8');

const stop = promiseHooks.onSettled((promise) => {});copy

promiseHooks.onBefore(before)#

• before <Function> 在 Promise 延续执行之前要调用的 before 回调。
• 返回: <Function> 停止钩子的调用。

before 钩子必须是一个普通函数。提供异步函数将抛出异常，因为它会导致无限微任务循环。

import { promiseHooks } from 'node:v8';

const stop = promiseHooks.onBefore((promise) => {});const { promiseHooks } = require('node:v8');

const stop = promiseHooks.onBefore((promise) => {});copy

promiseHooks.onAfter(after)#

• after <Function> 在 Promise 延续执行之后要调用的 after 回调。
• 返回: <Function> 停止钩子的调用。

after 钩子必须是一个普通函数。提供异步函数将抛出异常，因为它会导致无限微任务循环。

import { promiseHooks } from 'node:v8';

const stop = promiseHooks.onAfter((promise) => {});const { promiseHooks } = require('node:v8');

const stop = promiseHooks.onAfter((promise) => {});copy

promiseHooks.createHook(callbacks)#

• callbacks <Object> 要注册的 钩子回调
  • init <Function> init 回调。
  • before <Function> before 回调。
  • after <Function> after 回调。
  • settled <Function> settled 回调。
• 返回值: <Function> 用于禁用钩子

钩子回调必须是普通函数。提供异步函数将抛出异常，因为它会导致无限微任务循环。

注册函数，以便在每个 Promise 的不同生命周期事件中调用。

回调 init()/before()/after()/settled() 在 Promise 生命周期中的相应事件期间被调用。

所有回调都是可选的。例如，如果只需要跟踪 Promise 创建，则只需要传递 init 回调。可以传递给 callbacks 的所有函数的具体信息在 钩子回调 部分。

import { promiseHooks } from 'node:v8';

const stopAll = promiseHooks.createHook({
  init(promise, parent) {},
});const { promiseHooks } = require('node:v8');

const stopAll = promiseHooks.createHook({
  init(promise, parent) {},
});copy

钩子回调#

Promise 生命周期中的关键事件已分为四个区域：创建 Promise、在调用延续处理程序之前/之后或在 await 周围，以及 Promise 解决或拒绝时。

虽然这些钩子类似于 async_hooks 的钩子，但它们缺少 destroy 钩子。其他类型的异步资源通常代表套接字或文件描述符，它们具有不同的“关闭”状态来表达 destroy 生命周期事件，而 Promise 只要代码仍然可以访问它们，就一直可以使用。垃圾收集跟踪用于使 Promise 适应 async_hooks 事件模型，但是这种跟踪非常昂贵，而且它们可能永远不会被垃圾收集。

由于 Promise 是异步资源，其生命周期通过 Promise 钩子机制进行跟踪，因此 init()、before()、after() 和 settled() 回调不能是异步函数，因为它们会创建更多 Promise，从而导致无限循环。

虽然此 API 用于将 promise 事件馈送到 async_hooks，但两者之间的顺序是未定义的。这两个 API 都是多租户的，因此可能以相对于彼此的任何顺序生成事件。

init(promise, parent)#

• promise <Promise> 创建的 promise。
• parent <Promise> 如果适用，则从该 promise 继续。

在构造 promise 时调用。这不意味着相应的before/after事件会发生，只是存在这种可能性。如果 promise 在没有获得延续的情况下创建，就会发生这种情况。

before(promise)#

• promise <Promise>

在 promise 延续执行之前调用。这可能是以then()、catch()或finally()处理程序或await恢复的形式。

before回调将被调用 0 到 N 次。如果 promise 从未进行过延续，before回调通常会被调用 0 次。如果从同一个 promise 进行了多次延续，before回调可能会被多次调用。

after(promise)#

• promise <Promise>

在 promise 延续执行后立即调用。这可能是then()、catch()或finally()处理程序之后，或者在另一个await之后的await之前。

settled(promise)#

• promise <Promise>

当 promise 接收解析或拒绝值时调用。这可能在Promise.resolve()或Promise.reject()的情况下同步发生。

启动快照 API#

v8.startupSnapshot 接口可用于添加自定义启动快照的序列化和反序列化钩子。

$ node --snapshot-blob snapshot.blob --build-snapshot entry.js
# This launches a process with the snapshot
$ node --snapshot-blob snapshot.blob copy

在上面的示例中，entry.js 可以使用 v8.startupSnapshot 接口中的方法来指定如何在序列化期间将自定义对象的信息保存到快照中，以及如何在反序列化快照期间使用这些信息来同步这些对象。例如，如果 entry.js 包含以下脚本

'use strict';

const fs = require('node:fs');
const zlib = require('node:zlib');
const path = require('node:path');
const assert = require('node:assert');

const v8 = require('node:v8');

class BookShelf {
  storage = new Map();

  // Reading a series of files from directory and store them into storage.
  constructor(directory, books) {
    for (const book of books) {
      this.storage.set(book, fs.readFileSync(path.join(directory, book)));
    }
  }

  static compressAll(shelf) {
    for (const [ book, content ] of shelf.storage) {
      shelf.storage.set(book, zlib.gzipSync(content));
    }
  }

  static decompressAll(shelf) {
    for (const [ book, content ] of shelf.storage) {
      shelf.storage.set(book, zlib.gunzipSync(content));
    }
  }
}

// __dirname here is where the snapshot script is placed
// during snapshot building time.
const shelf = new BookShelf(__dirname, [
  'book1.en_US.txt',
  'book1.es_ES.txt',
  'book2.zh_CN.txt',
]);

assert(v8.startupSnapshot.isBuildingSnapshot());
// On snapshot serialization, compress the books to reduce size.
v8.startupSnapshot.addSerializeCallback(BookShelf.compressAll, shelf);
// On snapshot deserialization, decompress the books.
v8.startupSnapshot.addDeserializeCallback(BookShelf.decompressAll, shelf);
v8.startupSnapshot.setDeserializeMainFunction((shelf) => {
  // process.env and process.argv are refreshed during snapshot
  // deserialization.
  const lang = process.env.BOOK_LANG || 'en_US';
  const book = process.argv[1];
  const name = `${book}.${lang}.txt`;
  console.log(shelf.storage.get(name));
}, shelf); copy

生成的二进制文件将在启动时打印从快照中反序列化的数据，使用启动进程刷新的 process.env 和 process.argv

$ BOOK_LANG=es_ES node --snapshot-blob snapshot.blob book1
# Prints content of book1.es_ES.txt deserialized from the snapshot. copy

目前，从用户空间快照反序列化的应用程序无法再次快照，因此这些 API 仅适用于未从用户空间快照反序列化的应用程序。

v8.startupSnapshot.addSerializeCallback(callback[, data])#

• callback <Function> 序列化之前调用的回调函数。
• data <any> 可选数据，将在回调函数被调用时传递给它。

添加一个回调函数，该函数将在 Node.js 实例即将被序列化到快照并退出时被调用。这可用于释放不应或无法序列化的资源，或将用户数据转换为更适合序列化的形式。

回调函数按添加顺序执行。

v8.startupSnapshot.addDeserializeCallback(callback[, data])#

• callback <Function> 快照反序列化后调用的回调函数。
• data <any> 可选数据，将在回调函数被调用时传递给它。

添加一个回调函数，当 Node.js 实例从快照中反序列化时调用。callback 和 data（如果提供）将被序列化到快照中，它们可以用于重新初始化应用程序的状态或重新获取应用程序在从快照中重启时需要的资源。

回调函数按添加顺序执行。

v8.startupSnapshot.setDeserializeMainFunction(callback[, data])#

• callback <Function> 在快照反序列化后作为入口点调用的回调函数。
• data <any> 可选数据，将在回调函数被调用时传递给它。

这将设置 Node.js 应用程序从快照中反序列化时的入口点。这只能在快照构建脚本中调用一次。如果调用，反序列化的应用程序不再需要额外的入口点脚本启动，并将简单地调用回调函数以及反序列化的数据（如果提供），否则反序列化的应用程序仍然需要提供一个入口点脚本。

v8.startupSnapshot.isBuildingSnapshot()#

• 返回值: <boolean>

如果 Node.js 实例运行以构建快照，则返回 true。

类: v8.GCProfiler#

此 API 在当前线程中收集 GC 数据。

new v8.GCProfiler()#

创建一个新的 v8.GCProfiler 类实例。

profiler.start()#

开始收集 GC 数据。

profiler.stop()#

停止收集 GC 数据并返回一个对象。对象的内容如下。

{
  "version": 1,
  "startTime": 1674059033862,
  "statistics": [
    {
      "gcType": "Scavenge",
      "beforeGC": {
        "heapStatistics": {
          "totalHeapSize": 5005312,
          "totalHeapSizeExecutable": 524288,
          "totalPhysicalSize": 5226496,
          "totalAvailableSize": 4341325216,
          "totalGlobalHandlesSize": 8192,
          "usedGlobalHandlesSize": 2112,
          "usedHeapSize": 4883840,
          "heapSizeLimit": 4345298944,
          "mallocedMemory": 254128,
          "externalMemory": 225138,
          "peakMallocedMemory": 181760
        },
        "heapSpaceStatistics": [
          {
            "spaceName": "read_only_space",
            "spaceSize": 0,
            "spaceUsedSize": 0,
            "spaceAvailableSize": 0,
            "physicalSpaceSize": 0
          }
        ]
      },
      "cost": 1574.14,
      "afterGC": {
        "heapStatistics": {
          "totalHeapSize": 6053888,
          "totalHeapSizeExecutable": 524288,
          "totalPhysicalSize": 5500928,
          "totalAvailableSize": 4341101384,
          "totalGlobalHandlesSize": 8192,
          "usedGlobalHandlesSize": 2112,
          "usedHeapSize": 4059096,
          "heapSizeLimit": 4345298944,
          "mallocedMemory": 254128,
          "externalMemory": 225138,
          "peakMallocedMemory": 181760
        },
        "heapSpaceStatistics": [
          {
            "spaceName": "read_only_space",
            "spaceSize": 0,
            "spaceUsedSize": 0,
            "spaceAvailableSize": 0,
            "physicalSpaceSize": 0
          }
        ]
      }
    }
  ],
  "endTime": 1674059036865
} copy

以下是一个示例。

const { GCProfiler } = require('v8');
const profiler = new GCProfiler();
profiler.start();
setTimeout(() => {
  console.log(profiler.stop());
}, 1000); copy