Node.js APIs might be deprecated for any of the following reasons:
\nNode.js uses three kinds of Deprecations:
\nA Documentation-only deprecation is one that is expressed only within the\nNode.js API docs. These generate no side-effects while running Node.js.\nSome Documentation-only deprecations trigger a runtime warning when launched\nwith --pending-deprecation flag (or its alternative,\nNODE_PENDING_DEPRECATION=1 environment variable), similarly to Runtime\ndeprecations below. Documentation-only deprecations that support that flag\nare explicitly labeled as such in the\nlist of Deprecated APIs.
A Runtime deprecation will, by default, generate a process warning that will\nbe printed to stderr the first time the deprecated API is used. When the\n--throw-deprecation command-line flag is used, a Runtime deprecation will\ncause an error to be thrown.
An End-of-Life deprecation is used when functionality is or will soon be removed\nfrom Node.js.
", "miscs": [ { "textRaw": "Revoking deprecations", "name": "revoking_deprecations", "desc": "Occasionally, the deprecation of an API might be reversed. In such situations,\nthis document will be updated with information relevant to the decision.\nHowever, the deprecation identifier will not be modified.
", "type": "misc", "displayName": "Revoking deprecations" }, { "textRaw": "List of deprecated APIs", "name": "list_of_deprecated_apis", "modules": [ { "textRaw": "DEP0001: `http.OutgoingMessage.prototype.flush`", "name": "dep0001:_`http.outgoingmessage.prototype.flush`", "meta": { "changes": [ { "version": "v14.0.0", "pr-url": "https://github.com/nodejs/node/pull/31164", "description": "End-of-Life." }, { "version": [ "v6.12.0", "v4.8.6" ], "pr-url": "https://github.com/nodejs/node/pull/10116", "description": "A deprecation code has been assigned." }, { "version": "v1.6.0", "pr-url": "https://github.com/nodejs/node/pull/1156", "description": "Runtime deprecation." } ] }, "desc": "Type: End-of-Life
\nOutgoingMessage.prototype.flush() has been removed. Use\nOutgoingMessage.prototype.flushHeaders() instead.
Type: End-of-Life
\nThe _linklist module is deprecated. Please use a userland alternative.
Type: End-of-Life
\nThe _writableState.buffer has been removed. Use _writableState.getBuffer()\ninstead.
Type: End-of-Life
\nThe CryptoStream.prototype.readyState property was removed.
Type: Runtime (supports --pending-deprecation)
The Buffer() function and new Buffer() constructor are deprecated due to\nAPI usability issues that can lead to accidental security issues.
As an alternative, use one of the following methods of constructing Buffer\nobjects:
Buffer.alloc(size[, fill[, encoding]]): Create a Buffer with\ninitialized memory.Buffer.allocUnsafe(size): Create a Buffer with\nuninitialized memory.Buffer.allocUnsafeSlow(size): Create a Buffer with uninitialized\nmemory.Buffer.from(array): Create a Buffer with a copy of arrayBuffer.from(arrayBuffer[, byteOffset[, length]]) -\nCreate a Buffer that wraps the given arrayBuffer.Buffer.from(buffer): Create a Buffer that copies buffer.Buffer.from(string[, encoding]): Create a Buffer\nthat copies string.Without --pending-deprecation, runtime warnings occur only for code not in\nnode_modules. This means there will not be deprecation warnings for\nBuffer() usage in dependencies. With --pending-deprecation, a runtime\nwarning results no matter where the Buffer() usage occurs.
Type: End-of-Life
\nWithin the child_process module's spawn(), fork(), and exec()\nmethods, the options.customFds option is deprecated. The options.stdio\noption should be used instead.
Type: End-of-Life
\nIn an earlier version of the Node.js cluster, a boolean property with the name\nsuicide was added to the Worker object. The intent of this property was to\nprovide an indication of how and why the Worker instance exited. In Node.js\n6.0.0, the old property was deprecated and replaced with a new\nworker.exitedAfterDisconnect property. The old property name did not\nprecisely describe the actual semantics and was unnecessarily emotion-laden.
Type: Documentation-only
\nThe node:constants module is deprecated. When requiring access to constants\nrelevant to specific Node.js builtin modules, developers should instead refer\nto the constants property exposed by the relevant module. For instance,\nrequire('node:fs').constants and require('node:os').constants.
Type: End-of-Life
\nUse of the crypto.pbkdf2() API without specifying a digest was deprecated\nin Node.js 6.0 because the method defaulted to using the non-recommended\n'SHA1' digest. Previously, a deprecation warning was printed. Starting in\nNode.js 8.0.0, calling crypto.pbkdf2() or crypto.pbkdf2Sync() with\ndigest set to undefined will throw a TypeError.
Beginning in Node.js v11.0.0, calling these functions with digest set to\nnull would print a deprecation warning to align with the behavior when digest\nis undefined.
Now, however, passing either undefined or null will throw a TypeError.
Type: End-of-Life
\nThe crypto.createCredentials() API was removed. Please use\ntls.createSecureContext() instead.
Type: End-of-Life
\nThe crypto.Credentials class was removed. Please use tls.SecureContext\ninstead.
Type: End-of-Life
\nDomain.dispose() has been removed. Recover from failed I/O actions\nexplicitly via error event handlers set on the domain instead.
Type: End-of-Life
\nCalling an asynchronous function without a callback throws a TypeError\nin Node.js 10.0.0 onwards. See https://github.com/nodejs/node/pull/12562.
Type: End-of-Life
\nThe fs.read() legacy String interface is deprecated. Use the Buffer\nAPI as mentioned in the documentation instead.
Type: End-of-Life
\nThe fs.readSync() legacy String interface is deprecated. Use the\nBuffer API as mentioned in the documentation instead.
Type: End-of-Life
\nThe GLOBAL and root aliases for the global property were deprecated\nin Node.js 6.0.0 and have since been removed.
Type: End-of-Life
\nIntl.v8BreakIterator was a non-standard extension and has been removed.\nSee Intl.Segmenter.
Type: End-of-Life
\nUnhandled promise rejections are deprecated. By default, promise rejections\nthat are not handled terminate the Node.js process with a non-zero exit\ncode. To change the way Node.js treats unhandled rejections, use the\n--unhandled-rejections command-line option.
Type: End-of-Life
\nIn certain cases, require('.') could resolve outside the package directory.\nThis behavior has been removed.
Type: End-of-Life
\nThe Server.connections property was deprecated in Node.js v0.9.7 and has\nbeen removed. Please use the Server.getConnections() method instead.
Type: End-of-Life
\nThe Server.listenFD() method was deprecated and removed. Please use\nServer.listen({fd: <number>}) instead.
Type: End-of-Life
\nThe os.tmpDir() API was deprecated in Node.js 7.0.0 and has since been\nremoved. Please use os.tmpdir() instead.
Type: End-of-Life
\nThe os.getNetworkInterfaces() method is deprecated. Please use the\nos.networkInterfaces() method instead.
Type: End-of-Life
\nThe REPLServer.prototype.convertToContext() API has been removed.
Type: Runtime
\nThe node:sys module is deprecated. Please use the util module instead.
Type: End-of-Life
\nutil.print() has been removed. Please use console.log() instead.
Type: End-of-Life
\nutil.puts() has been removed. Please use console.log() instead.
Type: End-of-Life
\nutil.debug() has been removed. Please use console.error() instead.
Type: End-of-Life
\nutil.error() has been removed. Please use console.error() instead.
Type: Documentation-only
\nThe SlowBuffer class is deprecated. Please use\nBuffer.allocUnsafeSlow(size) instead.
Type: Documentation-only
\nThe ecdh.setPublicKey() method is now deprecated as its inclusion in the\nAPI is not useful.
Type: Documentation-only
\nThe domain module is deprecated and should not be used.
Type: Documentation-only
\nThe events.listenerCount(emitter, eventName) API is\ndeprecated. Please use emitter.listenerCount(eventName) instead.
Type: Documentation-only
\nThe fs.exists(path, callback) API is deprecated. Please use\nfs.stat() or fs.access() instead.
Type: Documentation-only
\nThe fs.lchmod(path, mode, callback) API is deprecated.
Type: Documentation-only
\nThe fs.lchmodSync(path, mode) API is deprecated.
Type: Deprecation revoked
\nThe fs.lchown(path, uid, gid, callback) API was deprecated. The\ndeprecation was revoked because the requisite supporting APIs were added in\nlibuv.
Type: Deprecation revoked
\nThe fs.lchownSync(path, uid, gid) API was deprecated. The deprecation was\nrevoked because the requisite supporting APIs were added in libuv.
Type: Documentation-only
\nThe require.extensions property is deprecated.
Type: Documentation-only (supports --pending-deprecation)
The punycode module is deprecated. Please use a userland alternative\ninstead.
Type: End-of-Life
\nThe NODE_REPL_HISTORY_FILE environment variable was removed. Please use\nNODE_REPL_HISTORY instead.
Type: End-of-Life
\nThe tls.CryptoStream class was removed. Please use\ntls.TLSSocket instead.
Type: Documentation-only
\nThe tls.SecurePair class is deprecated. Please use\ntls.TLSSocket instead.
Type: Documentation-only
\nThe util.isArray() API is deprecated. Please use Array.isArray()\ninstead.
Type: Documentation-only
\nThe util.isBoolean() API is deprecated.
Type: Documentation-only
\nThe util.isBuffer() API is deprecated. Please use\nBuffer.isBuffer() instead.
Type: Documentation-only
\nThe util.isDate() API is deprecated.
Type: Documentation-only
\nThe util.isError() API is deprecated.
Type: Documentation-only
\nThe util.isFunction() API is deprecated.
Type: Documentation-only
\nThe util.isNull() API is deprecated.
Type: Documentation-only
\nThe util.isNullOrUndefined() API is deprecated.
Type: Documentation-only
\nThe util.isNumber() API is deprecated.
Type: Documentation-only
\nThe util.isObject() API is deprecated.
Type: Documentation-only
\nThe util.isPrimitive() API is deprecated.
Type: Documentation-only
\nThe util.isRegExp() API is deprecated.
Type: Documentation-only
\nThe util.isString() API is deprecated.
Type: Documentation-only
\nThe util.isSymbol() API is deprecated.
Type: Documentation-only
\nThe util.isUndefined() API is deprecated.
Type: Documentation-only
\nThe util.log() API is deprecated.
Type: Documentation-only
\nThe util._extend() API is deprecated.
Type: End-of-Life
\nThe fs.SyncWriteStream class was never intended to be a publicly accessible\nAPI and has been removed. No alternative API is available. Please use a userland\nalternative.
Type: End-of-Life
\n--debug activates the legacy V8 debugger interface, which was removed as\nof V8 5.8. It is replaced by Inspector which is activated with --inspect\ninstead.
Type: Documentation-only
\nThe node:http module ServerResponse.prototype.writeHeader() API is\ndeprecated. Please use ServerResponse.prototype.writeHead() instead.
The ServerResponse.prototype.writeHeader() method was never documented as an\nofficially supported API.
Type: Runtime
\nThe tls.createSecurePair() API was deprecated in documentation in Node.js\n0.11.3. Users should use tls.Socket instead.
Type: End-of-Life
\nThe node:repl module's REPL_MODE_MAGIC constant, used for replMode option,\nhas been removed. Its behavior has been functionally identical to that of\nREPL_MODE_SLOPPY since Node.js 6.0.0, when V8 5.0 was imported. Please use\nREPL_MODE_SLOPPY instead.
The NODE_REPL_MODE environment variable is used to set the underlying\nreplMode of an interactive node session. Its value, magic, is also\nremoved. Please use sloppy instead.
Type: Runtime
\nThe node:http module OutgoingMessage.prototype._headers and\nOutgoingMessage.prototype._headerNames properties are deprecated. Use one of\nthe public methods (e.g. OutgoingMessage.prototype.getHeader(),\nOutgoingMessage.prototype.getHeaders(),\nOutgoingMessage.prototype.getHeaderNames(),\nOutgoingMessage.prototype.getRawHeaderNames(),\nOutgoingMessage.prototype.hasHeader(),\nOutgoingMessage.prototype.removeHeader(),\nOutgoingMessage.prototype.setHeader()) for working with outgoing headers.
The OutgoingMessage.prototype._headers and\nOutgoingMessage.prototype._headerNames properties were never documented as\nofficially supported properties.
Type: Documentation-only
\nThe node:http module OutgoingMessage.prototype._renderHeaders() API is\ndeprecated.
The OutgoingMessage.prototype._renderHeaders property was never documented as\nan officially supported API.
Type: End-of-Life
\nnode debug corresponds to the legacy CLI debugger which has been replaced with\na V8-inspector based CLI debugger available through node inspect.
Type: End-of-Life
\nDebugContext has been removed in V8 and is not available in Node.js 10+.
\nDebugContext was an experimental API.
", "type": "module", "displayName": "DEP0069: `vm.runInDebugContext(string)`" }, { "textRaw": "DEP0070: `async_hooks.currentId()`", "name": "dep0070:_`async_hooks.currentid()`", "meta": { "changes": [ { "version": "v9.0.0", "pr-url": "https://github.com/nodejs/node/pull/14414", "description": "End-of-Life." }, { "version": "v8.2.0", "pr-url": "https://github.com/nodejs/node/pull/13490", "description": "Runtime deprecation." } ] }, "desc": "Type: End-of-Life
\nasync_hooks.currentId() was renamed to async_hooks.executionAsyncId() for\nclarity.
This change was made while async_hooks was an experimental API.
Type: End-of-Life
\nasync_hooks.triggerId() was renamed to async_hooks.triggerAsyncId() for\nclarity.
This change was made while async_hooks was an experimental API.
Type: End-of-Life
\nasync_hooks.AsyncResource.triggerId() was renamed to\nasync_hooks.AsyncResource.triggerAsyncId() for clarity.
This change was made while async_hooks was an experimental API.
Type: End-of-Life
\nAccessing several internal, undocumented properties of net.Server instances\nwith inappropriate names is deprecated.
As the original API was undocumented and not generally useful for non-internal\ncode, no replacement API is provided.
", "type": "module", "displayName": "DEP0073: Several internal properties of `net.Server`" }, { "textRaw": "DEP0074: `REPLServer.bufferedCommand`", "name": "dep0074:_`replserver.bufferedcommand`", "meta": { "changes": [ { "version": "v15.0.0", "pr-url": "https://github.com/nodejs/node/pull/33286", "description": "End-of-Life." }, { "version": "v9.0.0", "pr-url": "https://github.com/nodejs/node/pull/13687", "description": "Runtime deprecation." } ] }, "desc": "Type: End-of-Life
\nThe REPLServer.bufferedCommand property was deprecated in favor of\nREPLServer.clearBufferedCommand().
Type: End-of-Life
\nREPLServer.parseREPLKeyword() was removed from userland visibility.
Type: End-of-Life
\ntls.parseCertString() was a trivial parsing helper that was made public by\nmistake. While it was supposed to parse certificate subject and issuer strings,\nit never handled multi-value Relative Distinguished Names correctly.
Earlier versions of this document suggested using querystring.parse() as an\nalternative to tls.parseCertString(). However, querystring.parse() also does\nnot handle all certificate subjects correctly and should not be used.
Type: Runtime
\nModule._debug() is deprecated.
The Module._debug() function was never documented as an officially\nsupported API.
Type: End-of-Life
\nREPLServer.turnOffEditorMode() was removed from userland visibility.
Type: End-of-Life
\nUsing a property named inspect on an object to specify a custom inspection\nfunction for util.inspect() is deprecated. Use util.inspect.custom\ninstead. For backward compatibility with Node.js prior to version 6.4.0, both\ncan be specified.
Type: Documentation-only
\nThe internal path._makeLong() was not intended for public use. However,\nuserland modules have found it useful. The internal API is deprecated\nand replaced with an identical, public path.toNamespacedPath() method.
Type: Runtime
\nfs.truncate() fs.truncateSync() usage with a file descriptor is\ndeprecated. Please use fs.ftruncate() or fs.ftruncateSync() to work with\nfile descriptors.
Type: End-of-Life
\nREPLServer.prototype.memory() is only necessary for the internal mechanics of\nthe REPLServer itself. Do not use this function.
Type: End-of-Life.
\nThe ecdhCurve option to tls.createSecureContext() and tls.TLSSocket could\nbe set to false to disable ECDH entirely on the server only. This mode was\ndeprecated in preparation for migrating to OpenSSL 1.1.0 and consistency with\nthe client and is now unsupported. Use the ciphers parameter instead.
Type: End-of-Life
\nSince Node.js versions 4.4.0 and 5.2.0, several modules only intended for\ninternal usage were mistakenly exposed to user code through require(). These\nmodules were:
v8/tools/codemapv8/tools/consarrayv8/tools/csvparserv8/tools/logreaderv8/tools/profile_viewv8/tools/profilev8/tools/SourceMapv8/tools/splaytreev8/tools/tickprocessor-driverv8/tools/tickprocessornode-inspect/lib/_inspect (from 7.6.0)node-inspect/lib/internal/inspect_client (from 7.6.0)node-inspect/lib/internal/inspect_repl (from 7.6.0)The v8/* modules do not have any exports, and if not imported in a specific\norder would in fact throw errors. As such there are virtually no legitimate use\ncases for importing them through require().
On the other hand, node-inspect can be installed locally through a package\nmanager, as it is published on the npm registry under the same name. No source\ncode modification is necessary if that is done.
Type: End-of-Life
\nThe AsyncHooks sensitive API was never documented and had various minor issues.\nUse the AsyncResource API instead. See\nhttps://github.com/nodejs/node/issues/15572.
Type: End-of-Life
\nrunInAsyncIdScope doesn't emit the 'before' or 'after' event and can thus\ncause a lot of issues. See https://github.com/nodejs/node/issues/14328.
Type: Deprecation revoked
\nImporting assert directly was not recommended as the exposed functions use\nloose equality checks. The deprecation was revoked because use of the\nnode:assert module is not discouraged, and the deprecation caused developer\nconfusion.
Type: End-of-Life
\nNode.js used to support all GCM authentication tag lengths which are accepted by\nOpenSSL when calling decipher.setAuthTag(). Beginning with Node.js\nv11.0.0, only authentication tag lengths of 128, 120, 112, 104, 96, 64, and 32\nbits are allowed. Authentication tags of other lengths are invalid per\nNIST SP 800-38D.
Type: Runtime
\nThe crypto.DEFAULT_ENCODING property is deprecated.
Type: Documentation-only
\nAssigning properties to the top-level this as an alternative\nto module.exports is deprecated. Developers should use exports\nor module.exports instead.
Type: Documentation-only
\nThe crypto.fips property is deprecated. Please use crypto.setFips()\nand crypto.getFips() instead.
Type: Runtime
\nUsing assert.fail() with more than one argument is deprecated. Use\nassert.fail() with only one argument or use a different node:assert module\nmethod.
Type: Runtime
\ntimers.enroll() is deprecated. Please use the publicly documented\nsetTimeout() or setInterval() instead.
Type: Runtime
\ntimers.unenroll() is deprecated. Please use the publicly documented\nclearTimeout() or clearInterval() instead.
Type: Runtime
\nUsers of MakeCallback that add the domain property to carry context,\nshould start using the async_context variant of MakeCallback or\nCallbackScope, or the high-level AsyncResource class.
Type: End-of-Life
\nThe embedded API provided by AsyncHooks exposes .emitBefore() and\n.emitAfter() methods which are very easy to use incorrectly which can lead\nto unrecoverable errors.
Use asyncResource.runInAsyncScope() API instead which provides a much\nsafer, and more convenient, alternative. See\nhttps://github.com/nodejs/node/pull/18513.
Type: Compile-time
\nCertain versions of node::MakeCallback APIs available to native addons are\ndeprecated. Please use the versions of the API that accept an async_context\nparameter.
Type: Runtime
\nprocess.assert() is deprecated. Please use the assert module instead.
This was never a documented feature.
", "type": "module", "displayName": "DEP0100: `process.assert()`" }, { "textRaw": "DEP0101: `--with-lttng`", "name": "dep0101:_`--with-lttng`", "meta": { "changes": [ { "version": "v10.0.0", "pr-url": "https://github.com/nodejs/node/pull/18982", "description": "End-of-Life." } ] }, "desc": "Type: End-of-Life
\nThe --with-lttng compile-time option has been removed.
Type: End-of-Life
\nUsing the noAssert argument has no functionality anymore. All input is\nverified regardless of the value of noAssert. Skipping the verification\ncould lead to hard-to-find errors and crashes.
Type: Documentation-only (supports --pending-deprecation)
Using process.binding() in general should be avoided. The type checking\nmethods in particular can be replaced by using util.types.
This deprecation has been superseded by the deprecation of the\nprocess.binding() API (DEP0111).
Type: Documentation-only (supports --pending-deprecation)
When assigning a non-string property to process.env, the assigned value is\nimplicitly converted to a string. This behavior is deprecated if the assigned\nvalue is not a string, boolean, or number. In the future, such assignment might\nresult in a thrown error. Please convert the property to a string before\nassigning it to process.env.
Type: End-of-Life
\ndecipher.finaltol() has never been documented and was an alias for\ndecipher.final(). This API has been removed, and it is recommended to use\ndecipher.final() instead.
Type: Runtime
\nUsing crypto.createCipher() and crypto.createDecipher() must be\navoided as they use a weak key derivation function (MD5 with no salt) and static\ninitialization vectors. It is recommended to derive a key using\ncrypto.pbkdf2() or crypto.scrypt() with random salts and to use\ncrypto.createCipheriv() and crypto.createDecipheriv() to obtain the\nCipher and Decipher objects respectively.
Type: End-of-Life
\nThis was an undocumented helper function not intended for use outside Node.js\ncore and obsoleted by the removal of NPN (Next Protocol Negotiation) support.
", "type": "module", "displayName": "DEP0107: `tls.convertNPNProtocols()`" }, { "textRaw": "DEP0108: `zlib.bytesRead`", "name": "dep0108:_`zlib.bytesread`", "meta": { "changes": [ { "version": "v11.0.0", "pr-url": "https://github.com/nodejs/node/pull/23308", "description": "Runtime deprecation." }, { "version": "v10.0.0", "pr-url": "https://github.com/nodejs/node/pull/19414", "description": "Documentation-only deprecation." } ] }, "desc": "Type: Runtime
\nDeprecated alias for zlib.bytesWritten. This original name was chosen\nbecause it also made sense to interpret the value as the number of bytes\nread by the engine, but is inconsistent with other streams in Node.js that\nexpose values under these names.
Type: End-of-Life
\nSome previously supported (but strictly invalid) URLs were accepted through the\nhttp.request(), http.get(), https.request(),\nhttps.get(), and tls.checkServerIdentity() APIs because those were\naccepted by the legacy url.parse() API. The mentioned APIs now use the WHATWG\nURL parser that requires strictly valid URLs. Passing an invalid URL is\ndeprecated and support will be removed in the future.
Type: Documentation-only
\nThe produceCachedData option is deprecated. Use\nscript.createCachedData() instead.
Type: Documentation-only (supports --pending-deprecation)
process.binding() is for use by Node.js internal code only.
While process.binding() has not reached End-of-Life status in general, it is\nunavailable when policies are enabled.
Type: Runtime
\nThe node:dgram module previously contained several APIs that were never meant\nto accessed outside of Node.js core: Socket.prototype._handle,\nSocket.prototype._receiving, Socket.prototype._bindState,\nSocket.prototype._queue, Socket.prototype._reuseAddr,\nSocket.prototype._healthCheck(), Socket.prototype._stopReceiving(), and\ndgram._createSocketHandle().
Type: End-of-Life
\nCipher.setAuthTag() and Decipher.getAuthTag() are no longer available. They\nwere never documented and would throw when called.
Type: End-of-Life
\nThe crypto._toBuf() function was not designed to be used by modules outside\nof Node.js core and was removed.
Type: Documentation-only (supports --pending-deprecation)
In recent versions of Node.js, there is no difference between\ncrypto.randomBytes() and crypto.pseudoRandomBytes(). The latter is\ndeprecated along with the undocumented aliases crypto.prng() and\ncrypto.rng() in favor of crypto.randomBytes() and might be removed in a\nfuture release.
Type: Deprecation revoked
\nThe legacy URL API is deprecated. This includes url.format(),\nurl.parse(), url.resolve(), and the legacy urlObject. Please\nuse the WHATWG URL API instead.
Type: End-of-Life
\nPrevious versions of Node.js exposed handles to internal native objects through\nthe _handle property of the Cipher, Decipher, DiffieHellman,\nDiffieHellmanGroup, ECDH, Hash, Hmac, Sign, and Verify classes.\nThe _handle property has been removed because improper use of the native\nobject can lead to crashing the application.
Type: Runtime
\nPrevious versions of Node.js supported dns.lookup() with a falsy host name\nlike dns.lookup(false) due to backward compatibility.\nThis behavior is undocumented and is thought to be unused in real world apps.\nIt will become an error in future versions of Node.js.
Type: Documentation-only (supports --pending-deprecation)
process.binding('uv').errname() is deprecated. Please use\nutil.getSystemErrorName() instead.
Type: End-of-Life
\nWindows Performance Counter support has been removed from Node.js. The\nundocumented COUNTER_NET_SERVER_CONNECTION(),\nCOUNTER_NET_SERVER_CONNECTION_CLOSE(), COUNTER_HTTP_SERVER_REQUEST(),\nCOUNTER_HTTP_SERVER_RESPONSE(), COUNTER_HTTP_CLIENT_REQUEST(), and\nCOUNTER_HTTP_CLIENT_RESPONSE() functions have been deprecated.
Type: Runtime
\nThe undocumented net._setSimultaneousAccepts() function was originally\nintended for debugging and performance tuning when using the\nnode:child_process and node:cluster modules on Windows. The function is not\ngenerally useful and is being removed. See discussion here:\nhttps://github.com/nodejs/node/issues/18391
Type: Runtime
\nPlease use Server.prototype.setSecureContext() instead.
Type: Runtime
\nSetting the TLS ServerName to an IP address is not permitted by\nRFC 6066. This will be ignored in a future version.
", "type": "module", "displayName": "DEP0123: setting the TLS ServerName to an IP address" }, { "textRaw": "DEP0124: using `REPLServer.rli`", "name": "dep0124:_using_`replserver.rli`", "meta": { "changes": [ { "version": "v15.0.0", "pr-url": "https://github.com/nodejs/node/pull/33286", "description": "End-of-Life." }, { "version": "v12.0.0", "pr-url": "https://github.com/nodejs/node/pull/26260", "description": "Runtime deprecation." } ] }, "desc": "Type: End-of-Life
\nThis property is a reference to the instance itself.
", "type": "module", "displayName": "DEP0124: using `REPLServer.rli`" }, { "textRaw": "DEP0125: `require('node:_stream_wrap')`", "name": "dep0125:_`require('node:_stream_wrap')`", "meta": { "changes": [ { "version": "v12.0.0", "pr-url": "https://github.com/nodejs/node/pull/26245", "description": "Runtime deprecation." } ] }, "desc": "Type: Runtime
\nThe node:_stream_wrap module is deprecated.
Type: Runtime
\nThe previously undocumented timers.active() is deprecated.\nPlease use the publicly documented timeout.refresh() instead.\nIf re-referencing the timeout is necessary, timeout.ref() can be used\nwith no performance impact since Node.js 10.
Type: Runtime
\nThe previously undocumented and \"private\" timers._unrefActive() is deprecated.\nPlease use the publicly documented timeout.refresh() instead.\nIf unreferencing the timeout is necessary, timeout.unref() can be used\nwith no performance impact since Node.js 10.
Type: Runtime
\nModules that have an invalid main entry (e.g., ./does-not-exist.js) and\nalso have an index.js file in the top level directory will resolve the\nindex.js file. That is deprecated and is going to throw an error in future\nNode.js versions.
Type: Runtime
\nThe _channel property of child process objects returned by spawn() and\nsimilar functions is not intended for public use. Use ChildProcess.channel\ninstead.
Type: End-of-Life
\nUse module.createRequire() instead.
Type: End-of-Life
\nThe legacy HTTP parser, used by default in versions of Node.js prior to 12.0.0,\nis deprecated and has been removed in v13.0.0. Prior to v13.0.0, the\n--http-parser=legacy command-line flag could be used to revert to using the\nlegacy parser.
Type: Runtime
\nPassing a callback to worker.terminate() is deprecated. Use the returned\nPromise instead, or a listener to the worker's 'exit' event.
Type: Documentation-only
\nPrefer response.socket over response.connection and\nrequest.socket over request.connection.
Type: Documentation-only (supports --pending-deprecation)
The process._tickCallback property was never documented as\nan officially supported API.
Type: Runtime
\nWriteStream.open() and ReadStream.open() are undocumented internal\nAPIs that do not make sense to use in userland. File streams should always be\nopened through their corresponding factory methods fs.createWriteStream()\nand fs.createReadStream()) or by passing a file descriptor in options.
Type: Documentation-only
\nresponse.finished indicates whether response.end() has been\ncalled, not whether 'finish' has been emitted and the underlying data\nis flushed.
Use response.writableFinished or response.writableEnded\naccordingly instead to avoid the ambiguity.
To maintain existing behavior response.finished should be replaced with\nresponse.writableEnded.
Type: Runtime
\nAllowing a fs.FileHandle object to be closed on garbage collection is\ndeprecated. In the future, doing so might result in a thrown error that will\nterminate the process.
Please ensure that all fs.FileHandle objects are explicitly closed using\nFileHandle.prototype.close() when the fs.FileHandle is no longer needed:
const fsPromises = require('node:fs').promises;\nasync function openAndClose() {\n let filehandle;\n try {\n filehandle = await fsPromises.open('thefile.txt', 'r');\n } finally {\n if (filehandle !== undefined)\n await filehandle.close();\n }\n}\nType: Documentation-only
\nprocess.mainModule is a CommonJS-only feature while process global\nobject is shared with non-CommonJS environment. Its use within ECMAScript\nmodules is unsupported.
It is deprecated in favor of require.main, because it serves the same\npurpose and is only available on CommonJS environment.
Type: Documentation-only
\nCalling process.umask() with no argument causes the process-wide umask to be\nwritten twice. This introduces a race condition between threads, and is a\npotential security vulnerability. There is no safe, cross-platform alternative\nAPI.
Type: Documentation-only
\nUse request.destroy() instead of request.abort().
Type: Documentation-only (supports --pending-deprecation)
The node:repl module exported the input and output stream twice. Use .input\ninstead of .inputStream and .output instead of .outputStream.
Type: Documentation-only
\nThe node:repl module exports a _builtinLibs property that contains an array\nof built-in modules. It was incomplete so far and instead it's better to rely\nupon require('node:module').builtinModules.
Type: Runtime\nTransform._transformState will be removed in future versions where it is\nno longer required due to simplification of the implementation.
Type: Documentation-only (supports --pending-deprecation)
A CommonJS module can access the first module that required it using\nmodule.parent. This feature is deprecated because it does not work\nconsistently in the presence of ECMAScript modules and because it gives an\ninaccurate representation of the CommonJS module graph.
Some modules use it to check if they are the entry point of the current process.\nInstead, it is recommended to compare require.main and module:
if (require.main === module) {\n // Code section that will run only if current file is the entry point.\n}\nWhen looking for the CommonJS modules that have required the current one,\nrequire.cache and module.children can be used:
const moduleParents = Object.values(require.cache)\n .filter((m) => m.children.includes(module));\nType: Documentation-only
\nsocket.bufferSize is just an alias for writable.writableLength.
Type: Documentation-only
\nThe crypto.Certificate() constructor is deprecated. Use\nstatic methods of crypto.Certificate() instead.
Type: Runtime
\nIn future versions of Node.js, recursive option will be ignored for\nfs.rmdir, fs.rmdirSync, and fs.promises.rmdir.
Use fs.rm(path, { recursive: true, force: true }),\nfs.rmSync(path, { recursive: true, force: true }) or\nfs.promises.rm(path, { recursive: true, force: true }) instead.
Type: Runtime
\nUsing a trailing \"/\" to define subpath folder mappings in the\nsubpath exports or subpath imports fields is deprecated. Use\nsubpath patterns instead.
Type: Documentation-only.
\nPrefer message.socket over message.connection.
Type: End-of-Life
\nThe process.config property provides access to Node.js compile-time settings.\nHowever, the property is mutable and therefore subject to tampering. The ability\nto change the value will be removed in a future version of Node.js.
Type: Runtime
\nPreviously, index.js and extension searching lookups would apply to\nimport 'pkg' main entry point resolution, even when resolving ES modules.
With this deprecation, all ES module main entry point resolutions require\nan explicit \"exports\" or \"main\" entry with the exact file extension.
Type: Runtime
\nThe 'gc', 'http2', and 'http' <PerformanceEntry> object types have\nadditional properties assigned to them that provide additional information.\nThese properties are now available within the standard detail property\nof the PerformanceEntry object. The existing accessors have been\ndeprecated and should no longer be used.
Type: End-of-Life
\nUsing a non-nullish non-integer value for family option, a non-nullish\nnon-number value for hints option, a non-nullish non-boolean value for all\noption, or a non-nullish non-boolean value for verbatim option in\ndns.lookup() and dnsPromises.lookup() throws an\nERR_INVALID_ARG_TYPE error.
Type: Documentation-only (supports --pending-deprecation)
The 'hash' and 'mgf1Hash' options are replaced with 'hashAlgorithm'\nand 'mgf1HashAlgorithm'.
Type: Runtime
\nThe remapping of specifiers ending in \"/\" like import 'pkg/x/' is deprecated\nfor package \"exports\" and \"imports\" pattern resolutions.
Type: Documentation-only
\nMove to <Stream> API instead, as the http.ClientRequest,\nhttp.ServerResponse, and http.IncomingMessage are all stream-based.\nCheck stream.destroyed instead of the .aborted property, and listen for\n'close' instead of 'abort', 'aborted' event.
The .aborted property and 'abort' event are only useful for detecting\n.abort() calls. For closing a request early, use the Stream\n.destroy([error]) then check the .destroyed property and 'close' event\nshould have the same effect. The receiving end should also check the\nreadable.readableEnded value on http.IncomingMessage to get whether\nit was an aborted or graceful destroy.
Type: End-of-Life
\nAn undocumented feature of Node.js streams was to support thenables in\nimplementation methods. This is now deprecated, use callbacks instead and avoid\nuse of async function for streams implementation methods.
\nThis feature caused users to encounter unexpected problems where the user\nimplements the function in callback style but uses e.g. an async method which\nwould cause an error since mixing promise and callback semantics is not valid.
\nconst w = new Writable({\n async final(callback) {\n await someOp();\n callback();\n },\n});\nType: Documentation-only
\nThis method was deprecated because it is not compatible with\nUint8Array.prototype.slice(), which is a superclass of Buffer.
Use buffer.subarray which does the same thing instead.
Type: End-of-Life
\nThis error code was removed due to adding more confusion to\nthe errors used for value type validation.
", "type": "module", "displayName": "DEP0159: `ERR_INVALID_CALLBACK`" }, { "textRaw": "DEP0160: `process.on('multipleResolves', handler)`", "name": "dep0160:_`process.on('multipleresolves',_handler)`", "meta": { "changes": [ { "version": "v18.0.0", "pr-url": "https://github.com/nodejs/node/pull/41896", "description": "Runtime deprecation." }, { "version": [ "v17.6.0", "v16.15.0" ], "pr-url": "https://github.com/nodejs/node/pull/41872", "description": "Documentation-only deprecation." } ] }, "desc": "Type: Runtime.
\nThis event was deprecated because it did not work with V8 promise combinators\nwhich diminished its usefulness.
", "type": "module", "displayName": "DEP0160: `process.on('multipleResolves', handler)`" }, { "textRaw": "DEP0161: `process._getActiveRequests()` and `process._getActiveHandles()`", "name": "dep0161:_`process._getactiverequests()`_and_`process._getactivehandles()`", "meta": { "changes": [ { "version": [ "v17.6.0", "v16.15.0" ], "pr-url": "https://github.com/nodejs/node/pull/41587", "description": "Documentation-only deprecation." } ] }, "desc": "Type: Documentation-only
\nThe process._getActiveHandles() and process._getActiveRequests()\nfunctions are not intended for public use and can be removed in future\nreleases.
Use process.getActiveResourcesInfo() to get a list of types of active\nresources and not the actual references.
Type: End-of-Life
\nImplicit coercion of objects with own toString property, passed as second\nparameter in fs.write(), fs.writeFile(), fs.appendFile(),\nfs.writeFileSync(), and fs.appendFileSync() is deprecated.\nConvert them to primitive strings.
Type: Documentation-only
\nThese methods were deprecated because they can be used in a way which does not\nhold the channel reference alive long enough to receive the events.
\nUse diagnostics_channel.subscribe(name, onMessage) or\ndiagnostics_channel.unsubscribe(name, onMessage) which does the same\nthing instead.
Type: Documentation-only
\nValues other than undefined, null, integer numbers, and integer strings\n(e.g., '1') are deprecated as value for the code parameter in\nprocess.exit() and as value to assign to process.exitCode.
Type: Documentation-only
\nThe --trace-atomics-wait flag is deprecated.
Type: Runtime
\nPackage imports and exports targets mapping into paths including a double slash\n(of \"/\" or \"\\\") are deprecated and will fail with a resolution validation\nerror in a future release. This same deprecation also applies to pattern matches\nstarting or ending in a slash.
", "type": "module", "displayName": "DEP0166: Double slashes in imports and exports targets" }, { "textRaw": "DEP0167: Weak `DiffieHellmanGroup` instances (`modp1`, `modp2`, `modp5`)", "name": "dep0167:_weak_`diffiehellmangroup`_instances_(`modp1`,_`modp2`,_`modp5`)", "meta": { "changes": [ { "version": "v18.10.0", "pr-url": "https://github.com/nodejs/node/pull/44588", "description": "Documentation-only deprecation." } ] }, "desc": "Type: Documentation-only
\nThe well-known MODP groups modp1, modp2, and modp5 are deprecated because\nthey are not secure against practical attacks. See RFC 8247 Section 2.4 for\ndetails.
These groups might be removed in future versions of Node.js. Applications that\nrely on these groups should evaluate using stronger MODP groups instead.
", "type": "module", "displayName": "DEP0167: Weak `DiffieHellmanGroup` instances (`modp1`, `modp2`, `modp5`)" }, { "textRaw": "DEP0168: Unhandled exception in Node-API callbacks", "name": "dep0168:_unhandled_exception_in_node-api_callbacks", "meta": { "changes": [ { "version": [ "v18.3.0", "v16.17.0" ], "pr-url": "https://github.com/nodejs/node/pull/36510", "description": "Runtime deprecation." } ] }, "desc": "Type: Runtime
\nThe implicit suppression of uncaught exceptions in Node-API callbacks is now\ndeprecated.
\nSet the flag --force-node-api-uncaught-exceptions-policy to force Node.js\nto emit an 'uncaughtException' event if the exception is not handled in\nNode-API callbacks.
Type: Documentation-only (supports --pending-deprecation)
url.parse() behavior is not standardized and prone to errors that\nhave security implications. Use the WHATWG URL API instead. CVEs are not\nissued for url.parse() vulnerabilities.
Type: Documentation-only
\nurl.parse() accepts URLs with ports that are not numbers. This behavior\nmight result in host name spoofing with unexpected input. These URLs will throw\nan error in future versions of Node.js, as the WHATWG URL API does already.
Type: Documentation-only
\nIn a future version of Node.js, message.headers,\nmessage.headersDistinct, message.trailers, and\nmessage.trailersDistinct will be read-only.
Type: Documentation-only
\nThe dirent.path is deprecated due to its lack of consistency across\nrelease lines. Please use dirent.parentPath instead.