已弃用的 API#

以下任何原因都可能导致 Node.js API 被弃用

  • 使用该 API 不安全。
  • 有更好的替代 API 可用。
  • 预计在未来的主要版本中对该 API 进行重大更改。

Node.js 使用四种弃用类型

  • 仅限文档
  • 应用程序(仅限非 node_modules 代码)
  • 运行时(所有代码)
  • 生命周期结束

仅限文档的弃用仅在 Node.js API 文档中表示。在运行 Node.js 时,它们不会产生任何副作用。一些仅限文档的弃用在使用 --pending-deprecation 标志(或其替代标志,环境变量 NODE_PENDING_DEPRECATION=1)启动时会触发运行时警告,类似于下面的运行时弃用。在 已弃用 API 列表 中明确标记了支持该标志的仅限文档的弃用。

仅限非 node_modules 代码的应用程序弃用在默认情况下会生成进程警告,该警告会在非 node_modules 加载的代码中首次使用已弃用的 API 时打印到 stderr。当使用 --throw-deprecation 命令行标志时,运行时弃用会导致抛出错误。当使用 --pending-deprecation 时,还会为从 node_modules 加载的代码发出警告。

所有代码的运行时弃用类似于非 node_modules 代码的运行时弃用,但它还会为从 node_modules 加载的代码发出警告。

当功能已或即将从 Node.js 中移除时,将使用生命周期结束弃用。

撤销弃用#

有时,API 的弃用可能会被撤销。在这种情况下,本文档将使用与该决策相关的信息进行更新。但是,弃用标识符不会被修改。

弃用 API 列表#

DEP0001: http.OutgoingMessage.prototype.flush#

类型:生命周期结束

OutgoingMessage.prototype.flush() 已被移除。请改用 OutgoingMessage.prototype.flushHeaders()

DEP0002: require('_linklist')#

类型:生命周期结束

_linklist 模块已弃用。请使用用户空间替代方案。

DEP0003: _writableState.buffer#

类型:生命周期结束

_writableState.buffer 已被移除。请改用 _writableState.getBuffer()

DEP0004: CryptoStream.prototype.readyState#

类型:生命周期结束

CryptoStream.prototype.readyState 属性已移除。

DEP0005: Buffer() 构造函数#

类型:应用程序(仅限非 node_modules 代码)

Buffer() 函数和 new Buffer() 构造函数已弃用,原因是 API 易用性问题可能导致意外的安全问题。

作为替代,请使用以下方法之一构造 Buffer 对象

如果没有 --pending-deprecation,只有不在 node_modules 中的代码才会出现运行时警告。这意味着依赖项中 Buffer() 的使用不会出现弃用警告。使用 --pending-deprecation,无论 Buffer() 的使用出现在哪里,都会导致运行时警告。

DEP0006:child_process options.customFds#

类型:生命周期结束

child_process 模块的 spawn()fork()exec() 方法中,options.customFds 选项已弃用。应该改用 options.stdio 选项。

DEP0007:用 worker.exitedAfterDisconnect 替换 cluster worker.suicide#

类型:生命周期结束

在 Node.js cluster 的早期版本中,一个名为 suicide 的布尔属性被添加到 Worker 对象中。此属性的目的是指示 Worker 实例如何以及为何退出。在 Node.js 6.0.0 中,旧属性已弃用,并替换为新的 worker.exitedAfterDisconnect 属性。旧属性名并未准确描述实际语义,并且不必要地带有情绪色彩。

DEP0008:require('node:constants')#

类型:仅限文档

node:constants 模块已弃用。当需要访问与特定 Node.js 内置模块相关的常量时,开发人员应该改为引用相关模块公开的 constants 属性。例如,require('node:fs').constantsrequire('node:os').constants

DEP0009:没有摘要的 crypto.pbkdf2#

类型:生命周期结束

在 Node.js 6.0 中,不指定摘要而使用 crypto.pbkdf2() API 已弃用,因为该方法默认使用不推荐的 'SHA1' 摘要。以前,会打印弃用警告。从 Node.js 8.0.0 开始,如果将 digest 设置为 undefined 来调用 crypto.pbkdf2()crypto.pbkdf2Sync(),则会抛出 TypeError

从 Node.js v11.0.0 开始,使用 digest 设置为 null 调用这些函数将打印弃用警告,以与 digestundefined 时的行为保持一致。

然而,现在传递 undefinednull 将抛出 TypeError

DEP0010: crypto.createCredentials#

类型:生命周期结束

已移除 crypto.createCredentials() API。请改用 tls.createSecureContext()

DEP0011: crypto.Credentials#

类型:生命周期结束

已移除 crypto.Credentials 类。请改用 tls.SecureContext

DEP0012: Domain.dispose#

类型:生命周期结束

已移除 Domain.dispose()。请改用在域上设置的错误事件处理程序显式地从失败的 I/O 操作中恢复。

DEP0013: fs 异步函数没有回调#

类型:生命周期结束

从 Node.js 10.0.0 开始,调用没有回调的异步函数会抛出 TypeError。请参阅 https://github.com/nodejs/node/pull/12562

DEP0014: fs.read 旧版 String 接口#

类型:生命周期结束

fs.read() 旧版 String 接口已弃用。请改用文档中提到的 Buffer API。

DEP0015: fs.readSync 旧版 String 接口#

类型:生命周期结束

fs.readSync() 旧版 String 接口已弃用。请改用文档中提到的 Buffer API。

DEP0016: GLOBAL/root#

类型:生命周期结束

GLOBALroot 别名在 Node.js 6.0.0 中已弃用,现已移除。

DEP0017: Intl.v8BreakIterator#

类型:生命周期结束

Intl.v8BreakIterator 是一个非标准扩展,现已移除。请参阅 Intl.Segmenter

DEP0018: 未处理的 Promise 拒绝#

类型:生命周期结束

未处理的 Promise 拒绝已弃用。默认情况下,未处理的 Promise 拒绝会以非零退出代码终止 Node.js 进程。要更改 Node.js 处理未处理拒绝的方式,请使用 --unhandled-rejections 命令行选项。

DEP0019: require('.') 在目录外部解析#

类型:生命周期结束

在某些情况下,require('.') 可能会在包目录外部解析。此行为已移除。

DEP0020: Server.connections#

类型:生命周期结束

Server.connections 属性在 Node.js v0.9.7 中已弃用,现已移除。请改用 Server.getConnections() 方法。

DEP0021: Server.listenFD#

类型:生命周期结束

Server.listenFD() 方法已弃用并移除。请改用 Server.listen({fd: <number>})

DEP0022: os.tmpDir()#

类型:生命周期结束

os.tmpDir() API 已在 Node.js 7.0.0 中弃用,现已移除。请改用 os.tmpdir()

DEP0023: os.getNetworkInterfaces()#

类型:生命周期结束

os.getNetworkInterfaces() 方法已弃用。请改用 os.networkInterfaces() 方法。

DEP0024: REPLServer.prototype.convertToContext()#

类型:生命周期结束

REPLServer.prototype.convertToContext() API 已移除。

DEP0025: require('node:sys')#

类型:运行时

node:sys 模块已弃用。请改用 util 模块。

DEP0026:util.print()#

类型:生命周期结束

util.print() 已被移除。请改用 console.log()

DEP0027:util.puts()#

类型:生命周期结束

util.puts() 已被移除。请改用 console.log()

DEP0028:util.debug()#

类型:生命周期结束

util.debug() 已被移除。请改用 console.error()

DEP0029:util.error()#

类型:生命周期结束

util.error() 已被移除。请改用 console.error()

DEP0030:SlowBuffer#

类型:仅限文档

SlowBuffer 类已弃用。请改用 Buffer.allocUnsafeSlow(size)

DEP0031:ecdh.setPublicKey()#

类型:仅限文档

ecdh.setPublicKey() 方法现已弃用,因为它包含在 API 中没有用。

DEP0032:node:domain 模块#

类型:仅限文档

domain 模块已弃用,不应使用。

DEP0033:EventEmitter.listenerCount()#

类型:仅限文档

events.listenerCount(emitter, eventName) API 已弃用。请改用 emitter.listenerCount(eventName)

DEP0034:fs.exists(path, callback)#

类型:仅限文档

fs.exists(path, callback) API 已弃用。请改用 fs.stat()fs.access()

DEP0035:fs.lchmod(path, mode, callback)#

类型:仅限文档

fs.lchmod(path, mode, callback) API 已弃用。

DEP0036:fs.lchmodSync(path, mode)#

类型:仅限文档

fs.lchmodSync(path, mode) API 已弃用。

DEP0037:fs.lchown(path, uid, gid, callback)#

类型:弃用撤销

API fs.lchown(path, uid, gid, callback) 已弃用。由于 libuv 中添加了必要的支持 API,因此撤销了弃用。

DEP0038: fs.lchownSync(path, uid, gid)#

类型:弃用撤销

API fs.lchownSync(path, uid, gid) 已弃用。由于 libuv 中添加了必要的支持 API,因此撤销了弃用。

DEP0039: require.extensions#

类型:仅限文档

属性 require.extensions 已弃用。

DEP0040: node:punycode 模块#

类型:运行时

模块 punycode 已弃用。请改用用户空间替代方案。

DEP0041: 环境变量 NODE_REPL_HISTORY_FILE#

类型:生命周期结束

已移除环境变量 NODE_REPL_HISTORY_FILE。请改用 NODE_REPL_HISTORY

DEP0042: tls.CryptoStream#

类型:生命周期结束

已移除类 tls.CryptoStream。请改用 tls.TLSSocket

DEP0043: tls.SecurePair#

类型:仅限文档

tls.SecurePair 已弃用。请改用 tls.TLSSocket

DEP0044: util.isArray()#

类型:仅限文档

API util.isArray() 已弃用。请改用 Array.isArray()

DEP0045: util.isBoolean()#

类型:仅限文档

API util.isBoolean() 已弃用。

DEP0046: util.isBuffer()#

类型:仅限文档

util.isBuffer() API 已弃用。请改用 Buffer.isBuffer()

DEP0047: util.isDate()#

类型:仅限文档

util.isDate() API 已弃用。

DEP0048: util.isError()#

类型:仅限文档

util.isError() API 已弃用。

DEP0049: util.isFunction()#

类型:仅限文档

util.isFunction() API 已弃用。

DEP0050: util.isNull()#

类型:仅限文档

util.isNull() API 已弃用。

DEP0051: util.isNullOrUndefined()#

类型:仅限文档

util.isNullOrUndefined() API 已弃用。

DEP0052: util.isNumber()#

类型:仅限文档

util.isNumber() API 已弃用。

DEP0053: util.isObject()#

类型:仅限文档

util.isObject() API 已弃用。

DEP0054: util.isPrimitive()#

类型:仅限文档

util.isPrimitive() API 已弃用。

DEP0055: util.isRegExp()#

类型:仅限文档

util.isRegExp() API 已弃用。

DEP0056: util.isString()#

类型:仅限文档

util.isString() API 已弃用。

DEP0057: util.isSymbol()#

类型:仅限文档

util.isSymbol() API 已弃用。

DEP0058: util.isUndefined()#

类型:仅限文档

util.isUndefined() API 已弃用。

DEP0059: util.log()#

类型:仅限文档

util.log() API 已弃用。

DEP0060: util._extend()#

类型:仅限文档

util._extend() API 已弃用。

DEP0061: fs.SyncWriteStream#

类型:生命周期结束

fs.SyncWriteStream 类从未打算成为一个公开可访问的 API,现已移除。没有可用的备用 API。请使用用户空间备用。

DEP0062: node --debug#

类型:生命周期结束

--debug 激活了旧版 V8 调试器界面,该界面已在 V8 5.8 中移除。它已被 Inspector 取代,后者通过 --inspect 激活。

DEP0063: ServerResponse.prototype.writeHeader()#

类型:仅限文档

node:http 模块的 ServerResponse.prototype.writeHeader() API 已弃用。请改用 ServerResponse.prototype.writeHead()

ServerResponse.prototype.writeHeader() 方法从未被记录为官方支持的 API。

DEP0064: tls.createSecurePair()#

类型:运行时

tls.createSecurePair() API 已在 Node.js 0.11.3 的文档中弃用。用户应改用 tls.Socket

DEP0065: repl.REPL_MODE_MAGICNODE_REPL_MODE=magic#

类型:生命周期结束

node:repl 模块的 REPL_MODE_MAGIC 常量(用于 replMode 选项)已移除。自 Node.js 6.0.0(导入 V8 5.0 时)以来,它的行为与 REPL_MODE_SLOPPY 的行为在功能上相同。请改用 REPL_MODE_SLOPPY

NODE_REPL_MODE 环境变量用于设置交互式 node 会话的基础 replMode。它的值 magic 也已移除。请改用 sloppy

DEP0066: OutgoingMessage.prototype._headers, OutgoingMessage.prototype._headerNames#

类型:运行时

node:http 模块的 OutgoingMessage.prototype._headersOutgoingMessage.prototype._headerNames 属性已弃用。使用其中一个公共方法(例如 OutgoingMessage.prototype.getHeader()OutgoingMessage.prototype.getHeaders()OutgoingMessage.prototype.getHeaderNames()OutgoingMessage.prototype.getRawHeaderNames()OutgoingMessage.prototype.hasHeader()OutgoingMessage.prototype.removeHeader()OutgoingMessage.prototype.setHeader())来处理传出标头。

OutgoingMessage.prototype._headersOutgoingMessage.prototype._headerNames 属性从未被记录为官方支持的属性。

DEP0067: OutgoingMessage.prototype._renderHeaders#

类型:仅限文档

node:http 模块 OutgoingMessage.prototype._renderHeaders() API 已弃用。

OutgoingMessage.prototype._renderHeaders 属性从未被记录为官方支持的 API。

DEP0068: node debug#

类型:生命周期结束

node debug 对应于旧版 CLI 调试器,该调试器已被基于 V8-inspector 的 CLI 调试器取代,可通过 node inspect 获得。

DEP0069: vm.runInDebugContext(string)#

类型:生命周期结束

DebugContext 已从 V8 中移除,在 Node.js 10+ 中不可用。

DebugContext 是一个实验性 API。

DEP0070: async_hooks.currentId()#

类型:生命周期结束

为了清晰起见,async_hooks.currentId() 已重命名为 async_hooks.executionAsyncId()

此更改是在 async_hooks 还是实验性 API 时进行的。

DEP0071: async_hooks.triggerId()#

类型:生命周期结束

为了清晰起见,async_hooks.triggerId() 已重命名为 async_hooks.triggerAsyncId()

此更改是在 async_hooks 还是实验性 API 时进行的。

DEP0072: async_hooks.AsyncResource.triggerId()#

类型:生命周期结束

为了清晰起见,async_hooks.AsyncResource.triggerId() 已重命名为 async_hooks.AsyncResource.triggerAsyncId()

此更改是在 async_hooks 还是实验性 API 时进行的。

DEP0073:net.Server 的多个内部属性#

类型:生命周期结束

不建议访问 net.Server 实例的多个内部、未记录的属性,这些属性名称不当。

由于原始 API 未记录且通常对非内部代码无用,因此未提供替代 API。

DEP0074:REPLServer.bufferedCommand#

类型:生命周期结束

REPLServer.bufferedCommand 属性已弃用,建议使用 REPLServer.clearBufferedCommand()

DEP0075:REPLServer.parseREPLKeyword()#

类型:生命周期结束

REPLServer.parseREPLKeyword() 已从用户可见性中移除。

DEP0076:tls.parseCertString()#

类型:生命周期结束

tls.parseCertString() 是一个简单的解析帮助器,由于错误而公开。虽然它应该解析证书主题和颁发者字符串,但它从未正确处理多值相对识别名称。

此文档的早期版本建议使用 querystring.parse() 作为 tls.parseCertString() 的替代方案。但是,querystring.parse() 也不正确处理所有证书主题,因此不应使用。

DEP0077:Module._debug()#

类型:运行时

Module._debug() 已弃用。

Module._debug() 函数从未作为官方支持的 API 记录。

DEP0078:REPLServer.turnOffEditorMode()#

类型:生命周期结束

REPLServer.turnOffEditorMode() 已从用户可见性中移除。

DEP0079:通过 .inspect() 对对象进行自定义检查函数#

类型:生命周期结束

不建议在对象上使用名为 inspect 的属性来为 util.inspect() 指定自定义检查函数。请改用 util.inspect.custom。为了向 6.4.0 版本之前的 Node.js 提供向后兼容性,可以同时指定这两个属性。

DEP0080:path._makeLong()#

类型:仅限文档

内部的 path._makeLong() 不适用于公开使用。但是,用户空间模块发现它很有用。内部 API 已弃用,并替换为相同的公开 path.toNamespacedPath() 方法。

DEP0081:使用文件描述符的 fs.truncate()#

类型:运行时

使用文件描述符的 fs.truncate() fs.truncateSync() 已弃用。请使用 fs.ftruncate()fs.ftruncateSync() 来处理文件描述符。

DEP0082:REPLServer.prototype.memory()#

类型:生命周期结束

REPLServer.prototype.memory() 仅对 REPLServer 本身的内部机制是必需的。请勿使用此函数。

DEP0083:通过将 ecdhCurve 设置为 false 来禁用 ECDH#

类型:生命周期结束。

tls.createSecureContext()tls.TLSSocketecdhCurve 选项可以设置为 false,以便仅在服务器上完全禁用 ECDH。此模式已弃用,为迁移到 OpenSSL 1.1.0 和与客户端保持一致做准备,现在不再受支持。请改用 ciphers 参数。

DEP0084:需要捆绑的内部依赖项#

类型:生命周期结束

自 Node.js 版本 4.4.0 和 5.2.0 以来,一些仅供内部使用的模块错误地通过 require() 向用户代码公开。这些模块是

  • v8/tools/codemap
  • v8/tools/consarray
  • v8/tools/csvparser
  • v8/tools/logreader
  • v8/tools/profile_view
  • v8/tools/profile
  • v8/tools/SourceMap
  • v8/tools/splaytree
  • v8/tools/tickprocessor-driver
  • v8/tools/tickprocessor
  • node-inspect/lib/_inspect(自 7.6.0 起)
  • node-inspect/lib/internal/inspect_client(自 7.6.0 起)
  • node-inspect/lib/internal/inspect_repl(自 7.6.0 起)

v8/* 模块没有任何导出,如果没有按特定顺序导入,实际上会引发错误。因此,几乎没有通过 require() 导入它们的合法用例。

另一方面,node-inspect 可以通过包管理器在本地安装,因为它在 npm 注册表中以相同名称发布。如果这样做,则无需修改源代码。

DEP0085:AsyncHooks 敏感 API#

类型:生命周期结束

AsyncHooks 敏感 API 从未记录,并且存在各种小问题。请改用 AsyncResource API。请参阅 https://github.com/nodejs/node/issues/15572

DEP0086:移除 runInAsyncIdScope#

类型:生命周期结束

runInAsyncIdScope 不会发出 'before''after' 事件,因此可能导致很多问题。请参阅 https://github.com/nodejs/node/issues/14328

DEP0089:require('node:assert')#

类型:弃用撤销

不建议直接导入 assert,因为公开的功能使用松散相等性检查。弃用已撤销,因为不建议使用 node:assert 模块,并且弃用导致开发人员困惑。

DEP0090:无效的 GCM 身份验证标记长度#

类型:生命周期结束

在调用 decipher.setAuthTag() 时,Node.js 曾经支持 OpenSSL 接受的所有 GCM 身份验证标记长度。从 Node.js v11.0.0 开始,仅允许身份验证标记长度为 128、120、112、104、96、64 和 32 位。根据 NIST SP 800-38D,其他长度的身份验证标记无效。

DEP0091:crypto.DEFAULT_ENCODING#

类型:生命周期结束

crypto.DEFAULT_ENCODING 属性仅与版本 0.9.3 之前的 Node.js 版本兼容,现已移除。

DEP0092:顶级 this 绑定到 module.exports#

类型:仅限文档

将属性分配给顶级 this 作为 module.exports 的替代方法已弃用。开发人员应改用 exportsmodule.exports

DEP0093:crypto.fips 已弃用并被替换#

类型:仅限文档

crypto.fips 属性已弃用。请改用 crypto.setFips()crypto.getFips()

DEP0094:使用带有多个参数的 assert.fail()#

类型:运行时

使用带有多个参数的 assert.fail() 已弃用。仅使用一个参数使用 assert.fail() 或使用其他 node:assert 模块方法。

DEP0095:timers.enroll()#

类型:运行时

timers.enroll() 已弃用。请使用公开记录的 setTimeout()setInterval()

DEP0096:timers.unenroll()#

类型:运行时

timers.unenroll() 已弃用。请使用公开记录的 clearTimeout()clearInterval()

DEP0097:带有 domain 属性的 MakeCallback#

类型:运行时

MakeCallback 添加 domain 属性以携带上下文的使用者应开始使用 MakeCallbackCallbackScopeasync_context 变体,或高级 AsyncResource 类。

DEP0098:AsyncHooks 嵌入器 AsyncResource.emitBeforeAsyncResource.emitAfter API#

类型:生命周期结束

AsyncHooks 提供的嵌入式 API 公开了 .emitBefore().emitAfter() 方法,这些方法很容易使用不当,从而导致无法恢复的错误。

改为使用 asyncResource.runInAsyncScope() API,它提供了一个更安全、更方便的替代方案。请参阅 https://github.com/nodejs/node/pull/18513

DEP0099:Async 上下文感知 node::MakeCallback C++ API#

类型:编译时

提供给原生插件的某些版本的 node::MakeCallback API 已弃用。请使用接受 async_context 参数的 API 版本。

DEP0100:process.assert()#

类型:运行时

process.assert() 已弃用。请改用 assert 模块。

这从未成为记录在案的功能。

DEP0101: --with-lttng#

类型:生命周期结束

--with-lttng 编译时选项已删除。

DEP0102: 在 Buffer#(read|write) 操作中使用 noAssert#

类型:生命周期结束

使用 noAssert 参数不再具有任何功能。所有输入都将得到验证,而不管 noAssert 的值如何。跳过验证可能会导致难以找到的错误和崩溃。

DEP0103: process.binding('util').is[...] 类型检查#

类型:仅限文档(支持 --pending-deprecation

一般来说,应避免使用 process.binding()。特别是,可以使用 util.types 替换类型检查方法。

此弃用已被 process.binding() API 的弃用(DEP0111)取代。

DEP0104: process.env 字符串强制转换#

类型:仅限文档(支持 --pending-deprecation

将非字符串属性分配给 process.env 时,分配的值会隐式转换为字符串。如果分配的值不是字符串、布尔值或数字,则此行为已弃用。将来,此类分配可能会导致抛出错误。请在将属性分配给 process.env 之前将其转换为字符串。

DEP0105: decipher.finaltol#

类型:生命周期结束

decipher.finaltol() 从未记录在案,是 decipher.final() 的别名。此 API 已删除,建议改用 decipher.final()

DEP0106: crypto.createCiphercrypto.createDecipher#

类型:运行时

应避免使用 crypto.createCipher()crypto.createDecipher(),因为它们使用弱密钥派生函数(无盐的 MD5)和静态初始化向量。建议使用 crypto.pbkdf2()crypto.scrypt() 使用随机盐派生密钥,并使用 crypto.createCipheriv()crypto.createDecipheriv() 分别获取 CipherDecipher 对象。

DEP0107: tls.convertNPNProtocols()#

类型:生命周期结束

这是一个未记录的帮助程序函数,不适用于 Node.js 核心外部,并且由于取消了 NPN(下一协议协商)支持而废弃。

DEP0108: zlib.bytesRead#

类型:运行时

zlib.bytesWritten 的弃用别名。之所以选择这个原始名称,是因为它还可以将该值解释为引擎读取的字节数,但与在这些名称下公开值的 Node.js 中的其他流不一致。

DEP0109: httphttpstls 对无效 URL 的支持#

类型:生命周期结束

由于旧版 url.parse() API 接受了一些以前支持(但严格无效)的 URL,因此通过 http.request()http.get()https.request()https.get()tls.checkServerIdentity() API 接受了这些 URL。现在,上述 API 使用 WHATWG URL 解析器,该解析器要求严格有效的 URL。传递无效 URL 已弃用,并且将来会取消支持。

DEP0110: vm.Script 缓存数据#

类型:仅限文档

produceCachedData 选项已弃用。请改用 script.createCachedData()

DEP0111: process.binding()#

类型:仅限文档(支持 --pending-deprecation

process.binding() 仅供 Node.js 内部代码使用。

虽然 process.binding() 尚未达到一般意义上的生命周期结束状态,但当策略权限模型启用时,它将不可用。

DEP0112: dgram 私有 API#

类型:运行时

node:dgram 模块以前包含几个本来就不应该在 Node.js 核心外部访问的 API:Socket.prototype._handleSocket.prototype._receivingSocket.prototype._bindStateSocket.prototype._queueSocket.prototype._reuseAddrSocket.prototype._healthCheck()Socket.prototype._stopReceiving()dgram._createSocketHandle()

DEP0113: Cipher.setAuthTag()Decipher.getAuthTag()#

类型:生命周期结束

Cipher.setAuthTag()Decipher.getAuthTag() 已不可用。它们从未记录在案,并且在调用时会引发异常。

DEP0114: crypto._toBuf()#

类型:生命周期结束

crypto._toBuf() 函数并非设计为供 Node.js 核心外部的模块使用,现已移除。

DEP0115: crypto.prng()crypto.pseudoRandomBytes()crypto.rng()#

类型:仅限文档(支持 --pending-deprecation

在最近版本的 Node.js 中,crypto.randomBytes()crypto.pseudoRandomBytes() 之间没有区别。后者已弃用,连同未记录的别名 crypto.prng()crypto.rng(),取而代之的是 crypto.randomBytes(),并可能在未来版本中移除。

DEP0116:旧版 URL API#

类型:弃用撤销

旧版 URL API 已被弃用。这包括 url.format()url.parse()url.resolve()旧版 urlObject。请改用 WHATWG URL API

DEP0117:原生加密句柄#

类型:生命周期结束

早期版本的 Node.js 通过 CipherDecipherDiffieHellmanDiffieHellmanGroupECDHHashHmacSignVerify 类的 _handle 属性公开了对内部原生对象的句柄。_handle 属性已被移除,因为不当使用原生对象会导致应用程序崩溃。

DEP0118:dns.lookup() 对虚假主机名的支持#

类型:运行时

早期版本的 Node.js 由于向后兼容性而支持带有虚假主机名的 dns.lookup(),例如 dns.lookup(false)。此行为未记录,并且被认为在实际应用中未使用。它将在未来版本的 Node.js 中成为错误。

DEP0119:process.binding('uv').errname() 私有 API#

类型:仅限文档(支持 --pending-deprecation

process.binding('uv').errname() 已被弃用。请改用 util.getSystemErrorName()

DEP0120:Windows 性能计数器支持#

类型:生命周期结束

Windows 性能计数器支持已从 Node.js 中移除。未记录的 COUNTER_NET_SERVER_CONNECTION()COUNTER_NET_SERVER_CONNECTION_CLOSE()COUNTER_HTTP_SERVER_REQUEST()COUNTER_HTTP_SERVER_RESPONSE()COUNTER_HTTP_CLIENT_REQUEST()COUNTER_HTTP_CLIENT_RESPONSE() 函数已弃用。

DEP0121:net._setSimultaneousAccepts()#

类型:运行时

未记录的 net._setSimultaneousAccepts() 函数最初用于在 Windows 上使用 node:child_processnode:cluster 模块时进行调试和性能调整。此函数通常没有用,并且正在被移除。请参阅此处讨论:https://github.com/nodejs/node/issues/18391

DEP0122:tls Server.prototype.setOptions()#

类型:运行时

请改用 Server.prototype.setSecureContext()

DEP0123:将 TLS ServerName 设置为 IP 地址#

类型:运行时

根据 RFC 6066,不允许将 TLS ServerName 设置为 IP 地址。此操作将在未来版本中被忽略。

DEP0124:使用 REPLServer.rli#

类型:生命周期结束

此属性是对实例本身的引用。

DEP0125:require('node:_stream_wrap')#

类型:运行时

node:_stream_wrap 模块已弃用。

DEP0126:timers.active()#

类型:运行时

以前未记录的 timers.active() 已弃用。请改用公开记录的 timeout.refresh()。如果需要重新引用超时,则可以使用 timeout.ref(),自 Node.js 10 起,它不会对性能产生影响。

DEP0127:timers._unrefActive()#

类型:运行时

以前未记录且“私有”的 timers._unrefActive() 已弃用。请改用公开记录的 timeout.refresh()。如果需要取消对超时的引用,则可以使用 timeout.unref(),自 Node.js 10 起,它不会对性能产生影响。

DEP0128:具有无效 main 条目和 index.js 文件的模块#

类型:运行时

具有无效 main 条目(例如 ./does-not-exist.js)并且在顶级目录中还具有 index.js 文件的模块将解析 index.js 文件。此操作已弃用,并且会在未来的 Node.js 版本中引发错误。

DEP0129:ChildProcess._channel#

类型:运行时

spawn() 和类似函数返回的子进程对象的 _channel 属性不适用于公共用途。请改用 ChildProcess.channel

DEP0130: Module.createRequireFromPath()#

类型:生命周期结束

改用 module.createRequire()

DEP0131: 传统的 HTTP 解析器#

类型:生命周期结束

传统的 HTTP 解析器在 12.0.0 之前的 Node.js 版本中默认使用,它已被弃用,并在 v13.0.0 中移除。在 v13.0.0 之前,可以使用命令行标志 --http-parser=legacy 恢复使用传统的解析器。

DEP0132: 带有回调的 worker.terminate()#

类型:运行时

将回调传递给 worker.terminate() 已弃用。改用返回的 Promise,或工作进程的 'exit' 事件的侦听器。

DEP0133: http connection#

类型:仅限文档

优先使用 response.socket 而非 response.connection,优先使用 request.socket 而非 request.connection

DEP0134: process._tickCallback#

类型:仅限文档(支持 --pending-deprecation

process._tickCallback 属性从未作为官方支持的 API 记录在案。

DEP0135: WriteStream.open()ReadStream.open() 是内部的#

类型:运行时

WriteStream.open()ReadStream.open() 是未记录的内部 API,在用户空间中使用它们没有意义。文件流应始终通过其对应的工厂方法 fs.createWriteStream()fs.createReadStream()(或在选项中传递文件描述符)打开。

DEP0136: http finished#

类型:仅限文档

response.finished 指示是否已调用 response.end(),而不是指示是否已发出 'finish' 并且已刷新底层数据。

相应地改用 response.writableFinishedresponse.writableEnded 以避免歧义。

为了保持现有行为,应将 response.finished 替换为 response.writableEnded

DEP0137:垃圾回收时关闭 fs.FileHandle#

类型:运行时

允许在垃圾回收时关闭 fs.FileHandle 对象已被弃用。将来,这样做可能会导致抛出一个错误,从而终止进程。

请确保在不再需要 fs.FileHandle 时,使用 FileHandle.prototype.close() 显式关闭所有 fs.FileHandle 对象

const fsPromises = require('node:fs').promises;
async function openAndClose() {
  let filehandle;
  try {
    filehandle = await fsPromises.open('thefile.txt', 'r');
  } finally {
    if (filehandle !== undefined)
      await filehandle.close();
  }
} 

DEP0138:process.mainModule#

类型:仅限文档

process.mainModule 仅是 CommonJS 特性,而 process 全局对象与非 CommonJS 环境共享。不支持在 ECMAScript 模块中使用它。

它已被弃用,取而代之的是 require.main,因为它具有相同的作用,并且仅在 CommonJS 环境中可用。

DEP0139:无参数的 process.umask()#

类型:仅限文档

无参数调用 process.umask() 会导致进程范围的 umask 被写入两次。这会在线程之间引入竞争条件,并且是一个潜在的安全漏洞。没有安全的跨平台备用 API。

DEP0140:使用 request.destroy() 代替 request.abort()#

类型:仅限文档

使用 request.destroy() 代替 request.abort()

DEP0141:repl.inputStreamrepl.outputStream#

类型:仅限文档(支持 --pending-deprecation

node:repl 模块导入了输入和输出流两次。使用 .input 代替 .inputStream,使用 .output 代替 .outputStream

DEP0142:repl._builtinLibs#

类型:仅限文档

node:repl 模块导出了一个 _builtinLibs 属性,其中包含一个内置模块数组。到目前为止它是不完整的,最好依赖于 require('node:module').builtinModules

DEP0143: Transform._transformState#

类型:由于简化实现,在未来不再需要时,运行时 Transform._transformState 将被移除。

DEP0144: module.parent#

类型:仅限文档(支持 --pending-deprecation

CommonJS 模块可以使用 module.parent 访问第一个需要它的模块。此功能已弃用,因为它在 ECMAScript 模块存在时无法始终如一地工作,并且因为它给出了 CommonJS 模块图的不准确表示。

一些模块使用它来检查它们是否是当前进程的入口点。相反,建议比较 require.mainmodule

if (require.main === module) {
  // Code section that will run only if current file is the entry point.
} 

在查找已需要当前模块的 CommonJS 模块时,可以使用 require.cachemodule.children

const moduleParents = Object.values(require.cache)
  .filter((m) => m.children.includes(module)); 

DEP0145: socket.bufferSize#

类型:仅限文档

socket.bufferSize 只是 writable.writableLength 的别名。

DEP0146: new crypto.Certificate()#

类型:仅限文档

已弃用 crypto.Certificate() 构造函数。请改用 crypto.Certificate()静态方法

DEP0147: fs.rmdir(path, { recursive: true })#

类型:运行时

在未来版本的 Node.js 中,将忽略 fs.rmdirfs.rmdirSyncfs.promises.rmdirrecursive 选项。

请改用 fs.rm(path, { recursive: true, force: true })fs.rmSync(path, { recursive: true, force: true })fs.promises.rm(path, { recursive: true, force: true })

DEP0148: "exports" 中的文件夹映射(尾随 "/"#

类型:运行时

子路径导出子路径导入 字段中使用尾随的 "/" 来定义子路径文件夹映射已弃用。请改用 子路径模式

DEP0149: http.IncomingMessage#connection#

类型:仅限文档。

优先使用 message.socket 而不是 message.connection

DEP0150: 更改 process.config 的值#

类型:生命周期结束

process.config 属性提供对 Node.js 编译时设置的访问。但是,该属性是可变的,因此可能会被篡改。在未来版本的 Node.js 中将删除更改该值的能力。

DEP0151: 主索引查找和扩展搜索#

类型:运行时

以前,index.js 和扩展搜索查找适用于 import 'pkg' 主入口点解析,即使解析 ES 模块也是如此。

通过此弃用,所有 ES 模块主入口点解析都需要一个明确的 "exports""main" 条目,其文件扩展名完全相同。

DEP0152: 扩展 PerformanceEntry 属性#

类型:运行时

'gc''http2''http' <PerformanceEntry> 对象类型具有分配给它们的附加属性,这些属性提供附加信息。这些属性现在可在 PerformanceEntry 对象的标准 detail 属性中获得。现有的访问器已弃用,不应再使用。

DEP0153: dns.lookupdnsPromises.lookup 选项类型强制转换#

类型:生命周期结束

dns.lookup()dnsPromises.lookup() 中为 family 选项使用非空非整数值,为 hints 选项使用非空非数字值,为 all 选项使用非空非布尔值,或为 verbatim 选项使用非空非布尔值会引发 ERR_INVALID_ARG_TYPE 错误。

DEP0154: RSA-PSS 生成密钥对选项#

类型:运行时

'hash''mgf1Hash' 选项已替换为 'hashAlgorithm''mgf1HashAlgorithm'

DEP0155:模式说明符解析中的尾随斜杠#

类型:运行时

"/" 结尾的说明符的重新映射,例如 import 'pkg/x/' 已弃用,用于程序包 "exports""imports" 模式解析。

DEP0156:.aborted 属性和 'abort''aborted' 事件在 http#

类型:仅限文档

改为使用 <Stream> API,因为 http.ClientRequesthttp.ServerResponsehttp.IncomingMessage 都是基于流的。检查 stream.destroyed 而不是 .aborted 属性,并侦听 'close' 而不是 'abort''aborted' 事件。

.aborted 属性和 'abort' 事件仅用于检测 .abort() 调用。要提前关闭请求,请使用流 .destroy([error]),然后检查 .destroyed 属性,'close' 事件应具有相同的效果。接收端还应检查 http.IncomingMessage 上的 readable.readableEnded 值,以获取它是中止还是正常销毁。

DEP0157:流中的 Thenable 支持#

类型:生命周期结束

Node.js 流的一个未记录特性是在实现方法中支持 thenable。这现在已弃用,请改用回调,并避免在流实现方法中使用 async 函数。

此特性导致用户遇到意外问题,即用户以回调方式实现函数,但使用例如 async 方法,这会导致错误,因为混合使用 promise 和回调语义无效。

const w = new Writable({
  async final(callback) {
    await someOp();
    callback();
  },
}); 

DEP0158:buffer.slice(start, end)#

类型:仅限文档

此方法已弃用,因为它与 Uint8Array.prototype.slice() 不兼容,后者是 Buffer 的超类。

请改用 buffer.subarray,它执行相同的功能。

DEP0159: ERR_INVALID_CALLBACK#

类型:生命周期结束

此错误代码已删除,因为它给用于值类型验证的错误增加了更多混乱。

DEP0160: process.on('multipleResolves', handler)#

类型:运行时。

此事件已弃用,因为它不适用于 V8 promise 组合器,这降低了它的实用性。

DEP0161: process._getActiveRequests()process._getActiveHandles()#

类型:仅限文档

process._getActiveHandles()process._getActiveRequests() 函数并非供公开使用,并且可能会在将来的版本中删除。

使用 process.getActiveResourcesInfo() 获取活动资源类型的列表,而不是实际引用。

DEP0162: fs.write()fs.writeFileSync() 转换为字符串#

类型:生命周期结束

fs.write()fs.writeFile()fs.appendFile()fs.writeFileSync()fs.appendFileSync() 中作为第二个参数传递的具有自身 toString 属性的对象的隐式转换已弃用。将它们转换为原始字符串。

DEP0163: channel.subscribe(onMessage)channel.unsubscribe(onMessage)#

类型:仅限文档

这些方法已弃用,因为它们的使用方式无法让通道引用保持足够长的时间来接收事件。

使用 diagnostics_channel.subscribe(name, onMessage)diagnostics_channel.unsubscribe(name, onMessage) 来代替。

DEP0164: process.exit(code)process.exitCode 转换为整数#

类型:生命周期结束

除了 undefinednull、整数和整数字符串(例如,'1')之外的值已弃用,不能作为 process.exit()code 参数的值,也不能赋值给 process.exitCode

DEP0165: --trace-atomics-wait#

类型:仅限文档

已弃用 --trace-atomics-wait 标志。

DEP0166:导入和导出目标中的双斜杠#

类型:运行时

已弃用映射到包含双斜杠("/""\")的路径的包导入和导出目标,并且在将来的版本中将因解析验证错误而失败。此弃用也适用于以斜杠开始或结束的模式匹配。

DEP0167:弱 DiffieHellmanGroup 实例(modp1modp2modp5#

类型:仅限文档

已弃用众所周知的 MODP 组 modp1modp2modp5,因为它们无法抵御实际攻击。有关详细信息,请参阅 RFC 8247 第 2.4 节

这些组可能会在 Node.js 的未来版本中被移除。依赖这些组的应用程序应考虑改为使用更强的 MODP 组。

DEP0168:Node-API 回调中的未处理异常#

类型:运行时

已弃用 Node-API 回调中未捕获异常的隐式抑制。

设置标志 --force-node-api-uncaught-exceptions-policy 以强制 Node.js 发出 'uncaughtException' 事件,如果异常未在 Node-API 回调中处理。

DEP0169:不安全的 url.parse()#

类型:仅限文档(支持 --pending-deprecation

url.parse() 行为未标准化,容易出现具有安全隐患的错误。请改用 WHATWG URL APIurl.parse() 漏洞不会发布 CVE。

DEP0170: 使用 url.parse() 时端口无效#

类型:运行时

url.parse() 接受端口不是数字的 URL。此行为可能会导致主机名欺骗,并出现意外输入。在未来版本的 Node.js 中,这些 URL 会引发错误,因为 WHATWG URL API 已经这样做。

DEP0171: http.IncomingMessage 标头和尾部的设置器#

类型:仅限文档

在未来版本的 Node.js 中,message.headersmessage.headersDistinctmessage.trailersmessage.trailersDistinct 将变为只读。

DEP0172: AsyncResource 绑定函数的 asyncResource 属性#

类型:运行时

在未来版本的 Node.js 中,将不再在函数绑定到 AsyncResource 时添加 asyncResource 属性。

DEP0173: assert.CallTracker#

类型:仅限文档

在未来版本的 Node.js 中,assert.CallTracker 将被移除。请考虑使用其他替代方案,例如 mock 帮助函数。

DEP0174: 对返回 Promise 的函数调用 promisify#

类型:运行时

对返回 的函数调用 util.promisify 将忽略该 promise 的结果,这可能会导致未处理的 promise 拒绝。

DEP0175: util.toUSVString#

类型:仅限文档

util.toUSVString() API 已弃用。请改用 String.prototype.toWellFormed

DEP0176: fs.F_OKfs.R_OKfs.W_OKfs.X_OK#

类型:仅限文档

直接在 node:fs 上公开的 F_OKR_OKW_OKX_OK getter 已弃用。请改从 fs.constantsfs.promises.constants 获取它们。

DEP0177: util.types.isWebAssemblyCompiledModule#

类型:生命周期结束

util.types.isWebAssemblyCompiledModule API 已移除。请改用 value instanceof WebAssembly.Module

DEP0178: dirent.path#

类型:仅限文档

dirent.path 因其在不同版本中缺乏一致性而被弃用。请改用 dirent.parentPath

DEP0179: Hash 构造函数#

类型:仅限文档

使用 Hash()new Hash() 直接调用 Hash 类已弃用,因为它们是内部函数,不打算公开使用。请使用 crypto.createHash() 方法创建 Hash 实例。