V8

源代码: lib/v8.js

node:v8 模块公开了特定于 Node.js 二进制文件中内置的 V8 版本的 API。可以使用以下方法访问它：

const v8 = require('node:v8')

`v8.cachedDataVersionTag()`

添加到: v8.0.0

返回: <整数>

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

console.log(v8.cachedDataVersionTag()) // 3947234607
// v8.cachedDataVersionTag() 返回的值来自 V8 版本、命令行标志和检测到的 CPU 功能。测试该值在切换标志时确实会更新。
v8.setFlagsFromString('--allow_natives_syntax')
console.log(v8.cachedDataVersionTag()) // 183726201

`v8.getHeapCodeStatistics()`

新增于：v12.8.0

返回值：<Object>

获取堆中代码及其元数据的统计信息，参见 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,
}

`v8.getHeapSnapshot([options])`

[历史]

版本	变更
v19.1.0	支持配置堆快照的选项。
v11.13.0	首次引入：v11.13.0

options <对象>
- exposeInternals <布尔值> 如果为真，则在堆快照中公开内部信息。默认值：false。
- exposeNumericValues <布尔值> 如果为真，则在人工字段中公开数值。默认值：false。
返回：<stream.Readable> 包含 V8 堆快照的可读流。

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

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

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

// 将堆快照打印到控制台
const v8 = require('node:v8')
const stream = v8.getHeapSnapshot()
stream.pipe(process.stdout)

`v8.getHeapSpaceStatistics()`

[历史]

版本	变更
v7.5.0	支持超过 32 位无符号整数范围的值。
v6.0.0	新增于：v6.0.0

返回值: <对象数组>

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

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

space_name <字符串>
space_size <数字>
space_used_size <数字>
space_available_size <数字>
physical_space_size <数字>

json

[
  {
    "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
  }
]

`v8.getHeapStatistics()`

[历史]

版本	变更
v7.5.0	支持超过 32 位无符号整数范围的值。
v7.2.0	新增 `malloced_memory`, `peak_malloced_memory`, 和 `does_zap_garbage`。
v1.0.0	首次添加：v1.0.0

返回值: <对象>

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

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

total_heap_size total_heap_size 的值是 V8 为堆分配的字节数。如果 used_heap 需要更多内存，则此值可能会增长。

total_heap_size_executable total_heap_size_executable 的值是堆中可以包含可执行代码的部分，以字节为单位。这包括 JIT 编译代码使用的内存以及必须保持可执行的任何内存。

total_physical_size total_physical_size 的值是 V8 堆实际使用的物理内存，以字节为单位。这是已提交（或正在使用）的内存量，而不是保留的内存量。

total_available_size total_available_size 的值是 V8 堆可用的内存字节数。此值表示 V8 在超过堆限制之前可以使用的最大内存量。

used_heap_size used_heap_size 的值是 V8 的 JavaScript 对象当前正在使用的字节数。这是实际使用的内存，不包括已分配但尚未使用的内存。

heap_size_limit heap_size_limit 的值是 V8 堆的最大大小，以字节为单位（默认限制，由系统资源确定，或传递给 --max_old_space_size 选项的值）。

malloced_memory malloced_memory 的值是 V8 通过 malloc 分配的字节数。

peak_malloced_memory peak_malloced_memory 的值是 V8 在进程生命周期内通过 malloc 分配的峰值字节数。

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

number_of_native_contexts native_context 的值是当前活动的顶级上下文数。此数字随时间的增加表明存在内存泄漏。

number_of_detached_contexts detached_context 的值是被分离且尚未被垃圾收集的上下文数。此数字非零表示潜在的内存泄漏。

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

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

external_memory 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
}

`v8.queryObjects(ctor[, options])`

新增于: v22.0.0, v20.13.0

[稳定性: 1 - 实验性]

稳定性: 1 稳定性: 1.1 - 活跃开发中

ctor <Function> 可用于在原型链上搜索以过滤堆中目标对象的构造函数。
options <undefined> | <Object>
- format <string> 如果为 'count'，则返回匹配对象的计数。如果为 'summary'，则返回包含匹配对象的摘要字符串的数组。
返回值:

这类似于 Chromium DevTools 控制台提供的 queryObjects() 控制台 API。它可以用于在完全垃圾回收后搜索堆中原型链上具有匹配构造函数的对象，这对于内存泄漏回归测试非常有用。为避免出现意外结果，用户应避免对他们不控制实现的构造函数或应用程序中其他方可以调用的构造函数使用此 API。

为避免意外泄漏，此 API 不会返回对找到对象的原始引用。默认情况下，它返回找到对象的计数。如果 options.format 为 'summary'，则它返回一个包含每个对象的简短字符串表示的数组。此 API 中提供的可见性类似于堆快照提供的可见性，而用户可以节省序列化和解析的成本，并在搜索过程中直接过滤目标对象。

结果中只包含在当前执行上下文中创建的对象。

CJSESM

const { queryObjects } = require('node:v8')
class A {
  foo = 'bar'
}
console.log(queryObjects(A)) // 0
const a = new A()
console.log(queryObjects(A)) // 1
// [ "A { foo: 'bar' }" ]
console.log(queryObjects(A, { format: 'summary' }))

class B extends A {
  bar = 'qux'
}
const b = new B()
console.log(queryObjects(B)) // 1
// [ "B { foo: 'bar', bar: 'qux' }" ]
console.log(queryObjects(B, { format: 'summary' }))

// 请注意，当存在继承自构造函数的子类时，
// 构造函数也会出现在子类的原型链中，因此子类的原型也会包含在结果中。
console.log(queryObjects(A)) // 3
// [ "B { foo: 'bar', bar: 'qux' }", 'A {}', "A { foo: 'bar' }" ]
console.log(queryObjects(A, { format: 'summary' }))

import { queryObjects } from 'node:v8'
class A {
  foo = 'bar'
}
console.log(queryObjects(A)) // 0
const a = new A()
console.log(queryObjects(A)) // 1
// [ "A { foo: 'bar' }" ]
console.log(queryObjects(A, { format: 'summary' }))

class B extends A {
  bar = 'qux'
}
const b = new B()
console.log(queryObjects(B)) // 1
// [ "B { foo: 'bar', bar: 'qux' }" ]
console.log(queryObjects(B, { format: 'summary' }))

// 请注意，当存在继承自构造函数的子类时，
// 构造函数也会出现在子类的原型链中，因此子类的原型也会包含在结果中。
console.log(queryObjects(A)) // 3
// [ "B { foo: 'bar', bar: 'qux' }", 'A {}', "A { foo: 'bar' }" ]
console.log(queryObjects(A, { format: 'summary' }))

`v8.setFlagsFromString(flags)`

Added in: v1.0.0

flags <string>

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

可用于 Node.js 版本的 V8 选项可以通过运行 node --v8-options 来确定。

用法：

// 将 GC 事件打印到标准输出，持续一分钟。
const v8 = require('node:v8')
v8.setFlagsFromString('--trace_gc')
setTimeout(() => {
  v8.setFlagsFromString('--notrace_gc')
}, 60e3)

`v8.stopCoverage()`

Added in: v15.1.0, v14.18.0, v12.22.0

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

`v8.takeCoverage()`

新增于：v15.1.0, v14.18.0, v12.22.0

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

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

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

[历史]

版本	变更
v19.1.0	支持配置堆快照的选项。
v18.0.0	如果无法写入文件，现在将抛出异常。
v18.0.0	使所有平台返回的错误代码保持一致。
v11.13.0	新增于：v11.13.0

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

生成当前 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(`工作线程堆转储：${filename}`)
    // 现在获取主线程的堆转储。
    console.log(`主线程堆转储：${writeHeapSnapshot()}`)
  })

  // 告诉工作线程创建堆转储。
  worker.postMessage('heapdump')
} else {
  parentPort.once('message', message => {
    if (message === 'heapdump') {
      // 为工作线程生成堆转储
      // 并将文件名返回给父进程。
      parentPort.postMessage(writeHeapSnapshot())
    }
  })
}

`v8.setHeapSnapshotNearHeapLimit(limit)`

新增于：v18.10.0, v16.18.0

[稳定性：1 - 实验性]

稳定性：1 稳定性：1 - 实验性

limit <整数>

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

序列化 API

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

该格式具有向后兼容性（即可以安全地存储到磁盘）。相等的 JavaScript 值可能会产生不同的序列化输出。

`v8.serialize(value)`

新增于：v8.0.0

value <any>
返回值: <Buffer>

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

尝试序列化需要缓冲区大小超过 buffer.constants.MAX_LENGTH 的大型对象时，将抛出 ERR_BUFFER_TOO_LARGE 错误。

`v8.deserialize(buffer)`

新增于：v8.0.0

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

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

类: `v8.Serializer`

新增于: v8.0.0

`new Serializer()`

创建一个新的 Serializer 对象。

`serializer.writeHeader()`

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

`serializer.writeValue(value)`

value <任意>

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

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

`serializer.releaseBuffer()`

返回: <Buffer>

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

`serializer.transferArrayBuffer(id, arrayBuffer)`

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

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

`serializer.writeUint32(value)`

value <整数>

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

`serializer.writeUint64(hi, lo)`

hi <整数>
lo <整数>

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

`serializer.writeDouble(value)`

value <数字>

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

`serializer.writeRawBytes(buffer)`

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

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

`serializer._writeHostObject(object)`

object <Object>

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

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

`serializer._getDataCloneError(message)`

message <string>

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

此方法默认为 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`

新增于: v8.0.0

`new Deserializer(buffer)`

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

创建一个新的 Deserializer 对象。

`deserializer.readHeader()`

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

`deserializer.readValue()`

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

`deserializer.transferArrayBuffer(id, arrayBuffer)`

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

标记一个 ArrayBuffer 的内容已通过带外方式传输。将相应的 ArrayBuffer 传递到序列化上下文中的 serializer.transferArrayBuffer()（对于 SharedArrayBuffer，则从 serializer._getSharedArrayBufferId() 返回 id）。

`deserializer.getWireFormatVersion()`

返回值: <整数>

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

`deserializer.readUint32()`

返回值: <整数>

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

`deserializer.readUint64()`

返回值: <整数[]>

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

`deserializer.readDouble()`

返回值: <数字>

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

`deserializer.readRawBytes(length)`

length <整数>
返回值: <Buffer>

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

`deserializer._readHostObject()`

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

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

类: `v8.DefaultSerializer`

新增于: v8.0.0

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

类：`v8.DefaultDeserializer`

新增于：v8.0.0

Deserializer 的子类，对应于 DefaultSerializer 编写的格式。

Promise Hook

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

import { promiseHooks } from 'node:v8'

// Promise 生成四个生命周期事件：

// `init` 事件表示 Promise 的创建。这可能是直接创建，例如使用 `new Promise(...)`，也可能是延续，例如 `then()` 或 `catch()`。当调用异步函数或执行 `await` 时，也会发生这种情况。如果创建了延续 Promise，则 `parent` 将是其延续的 Promise。
function init(promise, parent) {
  console.log('a promise was created', { promise, parent })
}

// 当 Promise 接收到解析值或拒绝值时，就会发生 `settled` 事件。这可能同步发生，例如当对非 Promise 输入使用 `Promise.resolve()` 时。
function settled(promise) {
  console.log('a promise resolved or rejected', { promise })
}

// `before` 事件在 `then()` 或 `catch()` 处理程序运行之前或 `await` 恢复执行之前立即运行。
function before(promise) {
  console.log('a promise is about to call a then handler', { promise })
}

// `after` 事件在 `then()` 处理程序运行之后或 `await` 从另一个 `await` 恢复后立即运行。
function after(promise) {
  console.log('a promise is done calling a then handler', { promise })
}

// 生命周期 Hook 可以单独启动和停止
const stopWatchingInits = promiseHooks.onInit(init)
const stopWatchingSettleds = promiseHooks.onSettled(settled)
const stopWatchingBefores = promiseHooks.onBefore(before)
const stopWatchingAfters = promiseHooks.onAfter(after)

// 或者可以分组启动和停止它们
const stopHookSet = promiseHooks.createHook({
  init,
  settled,
  before,
  after,
})

// 要停止 Hook，请调用在其创建时返回的函数。
stopWatchingInits()
stopWatchingSettleds()
stopWatchingBefores()
stopWatchingAfters()
stopHookSet()

`promiseHooks.onInit(init)`

新增于：v17.1.0, v16.14.0

init <Function> 创建 Promise 时调用的 init 回调函数。
返回值：<Function> 用于停止钩子的调用。

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

ESMCJS

import { promiseHooks } from 'node:v8'

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

const { promiseHooks } = require('node:v8')

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

`promiseHooks.onSettled(settled)`

新增于：v17.1.0, v16.14.0

settled <Function> Promise 完成（resolved 或 rejected）时调用的 settled 回调函数。
返回值：<Function> 用于停止钩子的调用。

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

ESMCJS

import { promiseHooks } from 'node:v8'

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

const { promiseHooks } = require('node:v8')

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

`promiseHooks.onBefore(before)`

新增于：v17.1.0, v16.14.0

before <Function> 在 promise 继续执行之前调用的 before 回调函数。
返回值: <Function> 停止钩子的调用。

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

ESMCJS

import { promiseHooks } from 'node:v8'

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

const { promiseHooks } = require('node:v8')

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

`promiseHooks.onAfter(after)`

新增于：v17.1.0, v16.14.0

after <Function> 在 promise 继续执行之后调用的 after 回调函数。
返回值: <Function> 停止钩子的调用。

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

ESMCJS

import { promiseHooks } from 'node:v8'

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

const { promiseHooks } = require('node:v8')

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

`promiseHooks.createHook(callbacks)`

新增于: v17.1.0, v16.14.0

callbacks <对象> 要注册的钩子回调函数
- init <函数> init 回调函数。
- before <函数> before 回调函数。
- after <函数> after 回调函数。
- settled <函数> settled 回调函数。
返回值: <函数> 用于禁用钩子

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

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

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

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

ESMCJS

import { promiseHooks } from 'node:v8'

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

const { promiseHooks } = require('node:v8')

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

Hook 回调函数

Promise 生命周期中的关键事件被分为四个方面：Promise 的创建，在继续处理程序调用之前/之后或围绕 await，以及 Promise 完成或拒绝时。

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

因为 Promise 是通过 Promise Hook 机制跟踪其生命周期的异步资源，所以 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

新增于：v18.6.0, v16.17.0

[稳定性：1 - 实验性]

稳定性：1 稳定性：1 - 实验性

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

bash

$ node --snapshot-blob snapshot.blob --build-snapshot entry.js
# 这将启动一个包含快照的进程 {#this-launches-a-process-with-the-snapshot}
$ node --snapshot-blob snapshot.blob

在上面的示例中，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()

  // 从目录读取一系列文件并将它们存储到 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 在此处是快照脚本在构建快照期间放置的位置。
const shelf = new BookShelf(__dirname, ['book1.en_US.txt', 'book1.es_ES.txt', 'book2.zh_CN.txt'])

assert(v8.startupSnapshot.isBuildingSnapshot())
// 在快照序列化时，压缩书籍以减小尺寸。
v8.startupSnapshot.addSerializeCallback(BookShelf.compressAll, shelf)
// 在快照反序列化时，解压书籍。
v8.startupSnapshot.addDeserializeCallback(BookShelf.decompressAll, shelf)
v8.startupSnapshot.setDeserializeMainFunction(shelf => {
  // process.env 和 process.argv 在快照反序列化期间被刷新。
  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)

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

bash

$ BOOK_LANG=es_ES node --snapshot-blob snapshot.blob book1
# 打印从快照反序列化的 book1.es_ES.txt 的内容。 {#prints-content-of-book1es_estxt-deserialized-from-the-snapshot}

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

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

新增于: v18.6.0, v16.17.0

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

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

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

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

新增于: v18.6.0, v16.17.0

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

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

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

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

新增于：v18.6.0, v16.17.0

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

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

`v8.startupSnapshot.isBuildingSnapshot()`

新增于：v18.6.0, v16.17.0

返回值：<boolean>

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

类: `v8.GCProfiler`

新增于: v19.6.0, v18.15.0

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

`new v8.GCProfiler()`

新增于: v19.6.0, v18.15.0

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

`profiler.start()`

新增于: v19.6.0, v18.15.0

开始收集 GC 数据。

`profiler.stop()`

新增于: v19.6.0, v18.15.0

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

json

{
  "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
}

这是一个示例。

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

V8 ​

v8.cachedDataVersionTag() ​

v8.getHeapCodeStatistics() ​

v8.getHeapSnapshot([options]) ​

v8.getHeapSpaceStatistics() ​

v8.getHeapStatistics() ​

v8.queryObjects(ctor[, options]) ​

v8.setFlagsFromString(flags) ​

v8.stopCoverage() ​

v8.takeCoverage() ​

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

v8.setHeapSnapshotNearHeapLimit(limit) ​

序列化 API ​

v8.serialize(value) ​

v8.deserialize(buffer) ​

类: v8.Serializer ​

new Serializer() ​

serializer.writeHeader() ​

serializer.writeValue(value) ​

serializer.releaseBuffer() ​

serializer.transferArrayBuffer(id, arrayBuffer) ​

serializer.writeUint32(value) ​

serializer.writeUint64(hi, lo) ​

serializer.writeDouble(value) ​

serializer.writeRawBytes(buffer) ​

serializer._writeHostObject(object) ​

serializer._getDataCloneError(message) ​

serializer._getSharedArrayBufferId(sharedArrayBuffer) ​

serializer._setTreatArrayBufferViewsAsHostObjects(flag) ​

类: v8.Deserializer ​

new Deserializer(buffer) ​

deserializer.readHeader() ​

deserializer.readValue() ​

deserializer.transferArrayBuffer(id, arrayBuffer) ​

deserializer.getWireFormatVersion() ​

deserializer.readUint32() ​

deserializer.readUint64() ​

deserializer.readDouble() ​

deserializer.readRawBytes(length) ​

deserializer._readHostObject() ​

类: v8.DefaultSerializer ​

类：v8.DefaultDeserializer ​

Promise Hook ​

promiseHooks.onInit(init) ​

promiseHooks.onSettled(settled) ​

promiseHooks.onBefore(before) ​

promiseHooks.onAfter(after) ​

promiseHooks.createHook(callbacks) ​

Hook 回调函数 ​

init(promise, parent) ​

before(promise) ​

after(promise) ​

settled(promise) ​

启动快照 API ​

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

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

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

v8.startupSnapshot.isBuildingSnapshot() ​

类: v8.GCProfiler ​

new v8.GCProfiler() ​

profiler.start() ​

profiler.stop() ​

V8

`v8.cachedDataVersionTag()`

`v8.getHeapCodeStatistics()`

`v8.getHeapSnapshot([options])`

`v8.getHeapSpaceStatistics()`

`v8.getHeapStatistics()`

`v8.queryObjects(ctor[, options])`

`v8.setFlagsFromString(flags)`

`v8.stopCoverage()`

`v8.takeCoverage()`

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

`v8.setHeapSnapshotNearHeapLimit(limit)`

序列化 API

`v8.serialize(value)`

`v8.deserialize(buffer)`

类: `v8.Serializer`

`new Serializer()`

`serializer.writeHeader()`

`serializer.writeValue(value)`

`serializer.releaseBuffer()`

`serializer.transferArrayBuffer(id, arrayBuffer)`

`serializer.writeUint32(value)`

`serializer.writeUint64(hi, lo)`

`serializer.writeDouble(value)`

`serializer.writeRawBytes(buffer)`

`serializer._writeHostObject(object)`

`serializer._getDataCloneError(message)`

`serializer._getSharedArrayBufferId(sharedArrayBuffer)`

`serializer._setTreatArrayBufferViewsAsHostObjects(flag)`

类: `v8.Deserializer`

`new Deserializer(buffer)`

`deserializer.readHeader()`

`deserializer.readValue()`

`deserializer.transferArrayBuffer(id, arrayBuffer)`

`deserializer.getWireFormatVersion()`

`deserializer.readUint32()`

`deserializer.readUint64()`

`deserializer.readDouble()`

`deserializer.readRawBytes(length)`

`deserializer._readHostObject()`

类: `v8.DefaultSerializer`

类：`v8.DefaultDeserializer`

Promise Hook

`promiseHooks.onInit(init)`

`promiseHooks.onSettled(settled)`

`promiseHooks.onBefore(before)`

`promiseHooks.onAfter(after)`

`promiseHooks.createHook(callbacks)`

Hook 回调函数

`init(promise, parent)`

`before(promise)`

`after(promise)`

`settled(promise)`

启动快照 API

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

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

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

`v8.startupSnapshot.isBuildingSnapshot()`

类: `v8.GCProfiler`

`new v8.GCProfiler()`

`profiler.start()`

`profiler.stop()`