{ "source": "doc/api/deprecations.md", "introduced_in": "v7.7.0", "miscs": [ { "textRaw": "Deprecated APIs", "name": "Deprecated APIs", "introduced_in": "v7.7.0", "type": "misc", "desc": "

Node.js may deprecate APIs when either: (a) use of the API is considered to be\nunsafe, (b) an improved alternative API has been made available, or (c)\nbreaking changes to the API are expected in a future major release.

\n

Node.js utilizes three kinds of Deprecations:

\n\n

A 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.

\n

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.

\n

An End-of-Life deprecation is used to identify code that either has been\nremoved or will soon be removed from Node.js.

\n", "miscs": [ { "textRaw": "Revoking deprecations", "name": "revoking_deprecations", "desc": "

Occasionally, the deprecation of an API may be reversed. In such situations,\nthis document will be updated with information relevant to the decision.\nHowever, the deprecation identifier will not be modified.

\n", "type": "misc", "displayName": "Revoking deprecations" }, { "textRaw": "List of Deprecated APIs", "name": "list_of_deprecated_apis", "desc": "

\n", "modules": [ { "textRaw": "DEP0001: http.OutgoingMessage.prototype.flush", "name": "dep0001:_http.outgoingmessage.prototype.flush", "desc": "

Type: Runtime

\n

The OutgoingMessage.prototype.flush() method is deprecated. Use\nOutgoingMessage.prototype.flushHeaders() instead.

\n

\n", "type": "module", "displayName": "DEP0001: http.OutgoingMessage.prototype.flush" }, { "textRaw": "DEP0002: require('\\_linklist')", "name": "dep0002:_require('\\_linklist')", "desc": "

Type: End-of-Life

\n

The _linklist module is deprecated. Please use a userland alternative.

\n

\n", "type": "module", "displayName": "DEP0002: require('\\_linklist')" }, { "textRaw": "DEP0003: \\_writableState.buffer", "name": "dep0003:_\\_writablestate.buffer", "desc": "

Type: Runtime

\n

The _writableState.buffer property is deprecated. Use the\n_writableState.getBuffer() method instead.

\n

\n", "type": "module", "displayName": "DEP0003: \\_writableState.buffer" }, { "textRaw": "DEP0004: CryptoStream.prototype.readyState", "name": "dep0004:_cryptostream.prototype.readystate", "desc": "

Type: Documentation-only

\n

The CryptoStream.prototype.readyState property is deprecated and should not\nbe used.

\n

\n", "type": "module", "displayName": "DEP0004: CryptoStream.prototype.readyState" }, { "textRaw": "DEP0005: Buffer() constructor", "name": "dep0005:_buffer()_constructor", "desc": "

Type: Runtime (supports --pending-deprecation)

\n

The Buffer() function and new Buffer() constructor are deprecated due to\nAPI usability issues that can potentially lead to accidental security issues.

\n

As an alternative, use of the following methods of constructing Buffer objects\nis strongly recommended:

\n\n

As of v10.0.0, a deprecation warning is printed at runtime when\n--pending-deprecation is used or when the calling code is\noutside node_modules in order to better target developers, rather than users.

\n

\n", "type": "module", "displayName": "DEP0005: Buffer() constructor" }, { "textRaw": "DEP0006: child\\_process options.customFds", "name": "dep0006:_child\\_process_options.customfds", "desc": "

Type: Runtime

\n

Within the child_process module's spawn(), fork(), and exec()\nmethods, the options.customFds option is deprecated. The options.stdio\noption should be used instead.

\n

\n", "type": "module", "displayName": "DEP0006: child\\_process options.customFds" }, { "textRaw": "DEP0007: Replace cluster worker.suicide with worker.exitedAfterDisconnect", "name": "dep0007:_replace_cluster_worker.suicide_with_worker.exitedafterdisconnect", "desc": "

Type: End-of-Life

\n

In 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.

\n

\n", "type": "module", "displayName": "DEP0007: Replace cluster worker.suicide with worker.exitedAfterDisconnect" }, { "textRaw": "DEP0008: require('constants')", "name": "dep0008:_require('constants')", "desc": "

Type: Documentation-only

\n

The constants module has been 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('fs').constants and require('os').constants.

\n

\n", "type": "module", "displayName": "DEP0008: require('constants')" }, { "textRaw": "DEP0009: crypto.pbkdf2 without digest", "name": "dep0009:_crypto.pbkdf2_without_digest", "desc": "

Type: End-of-Life

\n

Use 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 an\nundefined digest will throw a TypeError.

\n

\n", "type": "module", "displayName": "DEP0009: crypto.pbkdf2 without digest" }, { "textRaw": "DEP0010: crypto.createCredentials", "name": "dep0010:_crypto.createcredentials", "desc": "

Type: Runtime

\n

The crypto.createCredentials() API is deprecated. Please use\ntls.createSecureContext() instead.

\n

\n", "type": "module", "displayName": "DEP0010: crypto.createCredentials" }, { "textRaw": "DEP0011: crypto.Credentials", "name": "dep0011:_crypto.credentials", "desc": "

Type: Runtime

\n

The crypto.Credentials class is deprecated. Please use tls.SecureContext\ninstead.

\n

\n", "type": "module", "displayName": "DEP0011: crypto.Credentials" }, { "textRaw": "DEP0012: Domain.dispose", "name": "dep0012:_domain.dispose", "desc": "

Type: End-of-Life

\n

Domain.dispose() has been removed. Recover from failed I/O actions\nexplicitly via error event handlers set on the domain instead.

\n

\n", "type": "module", "displayName": "DEP0012: Domain.dispose" }, { "textRaw": "DEP0013: fs asynchronous function without callback", "name": "dep0013:_fs_asynchronous_function_without_callback", "desc": "

Type: End-of-Life

\n

Calling an asynchronous function without a callback throws a TypeError\nin Node.js 10.0.0 onwards. (See https://github.com/nodejs/node/pull/12562.)

\n

\n", "type": "module", "displayName": "DEP0013: fs asynchronous function without callback" }, { "textRaw": "DEP0014: fs.read legacy String interface", "name": "dep0014:_fs.read_legacy_string_interface", "desc": "

Type: End-of-Life

\n

The fs.read() legacy String interface is deprecated. Use the Buffer\nAPI as mentioned in the documentation instead.

\n

\n", "type": "module", "displayName": "DEP0014: fs.read legacy String interface" }, { "textRaw": "DEP0015: fs.readSync legacy String interface", "name": "dep0015:_fs.readsync_legacy_string_interface", "desc": "

Type: End-of-Life

\n

The fs.readSync() legacy String interface is deprecated. Use the\nBuffer API as mentioned in the documentation instead.

\n

\n", "type": "module", "displayName": "DEP0015: fs.readSync legacy String interface" }, { "textRaw": "DEP0016: GLOBAL/root", "name": "dep0016:_global/root", "desc": "

Type: Runtime

\n

The GLOBAL and root aliases for the global property have been deprecated\nand should no longer be used.

\n

\n", "type": "module", "displayName": "DEP0016: GLOBAL/root" }, { "textRaw": "DEP0017: Intl.v8BreakIterator", "name": "dep0017:_intl.v8breakiterator", "desc": "

Type: End-of-Life

\n

Intl.v8BreakIterator was a non-standard extension and has been removed.\nSee Intl.Segmenter.

\n

\n", "type": "module", "displayName": "DEP0017: Intl.v8BreakIterator" }, { "textRaw": "DEP0018: Unhandled promise rejections", "name": "dep0018:_unhandled_promise_rejections", "desc": "

Type: Runtime

\n

Unhandled promise rejections are deprecated. In the future, promise rejections\nthat are not handled will terminate the Node.js process with a non-zero exit\ncode.

\n

\n", "type": "module", "displayName": "DEP0018: Unhandled promise rejections" }, { "textRaw": "DEP0019: require('.') resolved outside directory", "name": "dep0019:_require('.')_resolved_outside_directory", "desc": "

Type: Runtime

\n

In certain cases, require('.') may resolve outside the package directory.\nThis behavior is deprecated and will be removed in a future major Node.js\nrelease.

\n

\n", "type": "module", "displayName": "DEP0019: require('.') resolved outside directory" }, { "textRaw": "DEP0020: Server.connections", "name": "dep0020:_server.connections", "desc": "

Type: Runtime

\n

The Server.connections property is deprecated. Please use the\nServer.getConnections() method instead.

\n

\n", "type": "module", "displayName": "DEP0020: Server.connections" }, { "textRaw": "DEP0021: Server.listenFD", "name": "dep0021:_server.listenfd", "desc": "

Type: Runtime

\n

The Server.listenFD() method is deprecated. Please use\nServer.listen({fd: <number>}) instead.

\n

\n", "type": "module", "displayName": "DEP0021: Server.listenFD" }, { "textRaw": "DEP0022: os.tmpDir()", "name": "dep0022:_os.tmpdir()", "desc": "

Type: Runtime

\n

The os.tmpDir() API is deprecated. Please use os.tmpdir() instead.

\n

\n", "type": "module", "displayName": "DEP0022: os.tmpDir()" }, { "textRaw": "DEP0023: os.getNetworkInterfaces()", "name": "dep0023:_os.getnetworkinterfaces()", "desc": "

Type: Runtime

\n

The os.getNetworkInterfaces() method is deprecated. Please use the\nos.networkInterfaces property instead.

\n

\n", "type": "module", "displayName": "DEP0023: os.getNetworkInterfaces()" }, { "textRaw": "DEP0024: REPLServer.prototype.convertToContext()", "name": "dep0024:_replserver.prototype.converttocontext()", "desc": "

Type: End-of-Life

\n

The REPLServer.prototype.convertToContext() API is deprecated and should\nnot be used.

\n

\n", "type": "module", "displayName": "DEP0024: REPLServer.prototype.convertToContext()" }, { "textRaw": "DEP0025: require('sys')", "name": "dep0025:_require('sys')", "desc": "

Type: Runtime

\n

The sys module is deprecated. Please use the util module instead.

\n

\n", "type": "module", "displayName": "DEP0025: require('sys')" }, { "textRaw": "DEP0026: util.print()", "name": "dep0026:_util.print()", "desc": "

Type: Runtime

\n

The util.print() API is deprecated. Please use console.log()\ninstead.

\n

\n", "type": "module", "displayName": "DEP0026: util.print()" }, { "textRaw": "DEP0027: util.puts()", "name": "dep0027:_util.puts()", "desc": "

Type: Runtime

\n

The util.puts() API is deprecated. Please use console.log() instead.

\n

\n", "type": "module", "displayName": "DEP0027: util.puts()" }, { "textRaw": "DEP0028: util.debug()", "name": "dep0028:_util.debug()", "desc": "

Type: Runtime

\n

The util.debug() API is deprecated. Please use console.error()\ninstead.

\n

\n", "type": "module", "displayName": "DEP0028: util.debug()" }, { "textRaw": "DEP0029: util.error()", "name": "dep0029:_util.error()", "desc": "

Type: Runtime

\n

The util.error() API is deprecated. Please use console.error()\ninstead.

\n

\n", "type": "module", "displayName": "DEP0029: util.error()" }, { "textRaw": "DEP0030: SlowBuffer", "name": "dep0030:_slowbuffer", "desc": "

Type: Documentation-only

\n

The SlowBuffer class has been deprecated. Please use\nBuffer.allocUnsafeSlow(size) instead.

\n

\n", "type": "module", "displayName": "DEP0030: SlowBuffer" }, { "textRaw": "DEP0031: ecdh.setPublicKey()", "name": "dep0031:_ecdh.setpublickey()", "desc": "

Type: Documentation-only

\n

The ecdh.setPublicKey() method is now deprecated as its inclusion in the\nAPI is not useful.

\n

\n", "type": "module", "displayName": "DEP0031: ecdh.setPublicKey()" }, { "textRaw": "DEP0032: domain module", "name": "dep0032:_domain_module", "desc": "

Type: Documentation-only

\n

The domain module is deprecated and should not be used.

\n

\n", "type": "module", "displayName": "DEP0032: domain module" }, { "textRaw": "DEP0033: EventEmitter.listenerCount()", "name": "dep0033:_eventemitter.listenercount()", "desc": "

Type: Documentation-only

\n

The EventEmitter.listenerCount(emitter, eventName) API has been\ndeprecated. Please use emitter.listenerCount(eventName) instead.

\n

\n", "type": "module", "displayName": "DEP0033: EventEmitter.listenerCount()" }, { "textRaw": "DEP0034: fs.exists(path, callback)", "name": "dep0034:_fs.exists(path,_callback)", "desc": "

Type: Documentation-only

\n

The fs.exists(path, callback) API has been deprecated. Please use\nfs.stat() or fs.access() instead.

\n

\n", "type": "module", "displayName": "DEP0034: fs.exists(path, callback)" }, { "textRaw": "DEP0035: fs.lchmod(path, mode, callback)", "name": "dep0035:_fs.lchmod(path,_mode,_callback)", "desc": "

Type: Documentation-only

\n

The fs.lchmod(path, mode, callback) API has been deprecated.

\n

\n", "type": "module", "displayName": "DEP0035: fs.lchmod(path, mode, callback)" }, { "textRaw": "DEP0036: fs.lchmodSync(path, mode)", "name": "dep0036:_fs.lchmodsync(path,_mode)", "desc": "

Type: Documentation-only

\n

The fs.lchmodSync(path, mode) API has been deprecated.

\n

\n", "type": "module", "displayName": "DEP0036: fs.lchmodSync(path, mode)" }, { "textRaw": "DEP0037: fs.lchown(path, uid, gid, callback)", "name": "dep0037:_fs.lchown(path,_uid,_gid,_callback)", "desc": "

Type: Documentation-only

\n

The fs.lchown(path, uid, gid, callback) API has been deprecated.

\n

\n", "type": "module", "displayName": "DEP0037: fs.lchown(path, uid, gid, callback)" }, { "textRaw": "DEP0038: fs.lchownSync(path, uid, gid)", "name": "dep0038:_fs.lchownsync(path,_uid,_gid)", "desc": "

Type: Documentation-only

\n

The fs.lchownSync(path, uid, gid) API has been deprecated.

\n

\n", "type": "module", "displayName": "DEP0038: fs.lchownSync(path, uid, gid)" }, { "textRaw": "DEP0039: require.extensions", "name": "dep0039:_require.extensions", "desc": "

Type: Documentation-only

\n

The require.extensions property has been deprecated.

\n

\n", "type": "module", "displayName": "DEP0039: require.extensions" }, { "textRaw": "DEP0040: punycode module", "name": "dep0040:_punycode_module", "desc": "

Type: Documentation-only

\n

The punycode module has been deprecated. Please use a userland alternative\ninstead.

\n

\n", "type": "module", "displayName": "DEP0040: punycode module" }, { "textRaw": "DEP0041: NODE\\_REPL\\_HISTORY\\_FILE environment variable", "name": "dep0041:_node\\_repl\\_history\\_file_environment_variable", "desc": "

Type: End-of-Life

\n

The NODE_REPL_HISTORY_FILE environment variable was removed. Please use\nNODE_REPL_HISTORY instead.

\n

\n", "type": "module", "displayName": "DEP0041: NODE\\_REPL\\_HISTORY\\_FILE environment variable" }, { "textRaw": "DEP0042: tls.CryptoStream", "name": "dep0042:_tls.cryptostream", "desc": "

Type: Documentation-only

\n

The tls.CryptoStream class has been deprecated. Please use\ntls.TLSSocket instead.

\n

\n", "type": "module", "displayName": "DEP0042: tls.CryptoStream" }, { "textRaw": "DEP0043: tls.SecurePair", "name": "dep0043:_tls.securepair", "desc": "

Type: Documentation-only

\n

The tls.SecurePair class has been deprecated. Please use\ntls.TLSSocket instead.

\n

\n", "type": "module", "displayName": "DEP0043: tls.SecurePair" }, { "textRaw": "DEP0044: util.isArray()", "name": "dep0044:_util.isarray()", "desc": "

Type: Documentation-only

\n

The util.isArray() API has been deprecated. Please use Array.isArray()\ninstead.

\n

\n", "type": "module", "displayName": "DEP0044: util.isArray()" }, { "textRaw": "DEP0045: util.isBoolean()", "name": "dep0045:_util.isboolean()", "desc": "

Type: Documentation-only

\n

The util.isBoolean() API has been deprecated.

\n

\n", "type": "module", "displayName": "DEP0045: util.isBoolean()" }, { "textRaw": "DEP0046: util.isBuffer()", "name": "dep0046:_util.isbuffer()", "desc": "

Type: Documentation-only

\n

The util.isBuffer() API has been deprecated. Please use\nBuffer.isBuffer() instead.

\n

\n", "type": "module", "displayName": "DEP0046: util.isBuffer()" }, { "textRaw": "DEP0047: util.isDate()", "name": "dep0047:_util.isdate()", "desc": "

Type: Documentation-only

\n

The util.isDate() API has been deprecated.

\n

\n", "type": "module", "displayName": "DEP0047: util.isDate()" }, { "textRaw": "DEP0048: util.isError()", "name": "dep0048:_util.iserror()", "desc": "

Type: Documentation-only

\n

The util.isError() API has been deprecated.

\n

\n", "type": "module", "displayName": "DEP0048: util.isError()" }, { "textRaw": "DEP0049: util.isFunction()", "name": "dep0049:_util.isfunction()", "desc": "

Type: Documentation-only

\n

The util.isFunction() API has been deprecated.

\n

\n", "type": "module", "displayName": "DEP0049: util.isFunction()" }, { "textRaw": "DEP0050: util.isNull()", "name": "dep0050:_util.isnull()", "desc": "

Type: Documentation-only

\n

The util.isNull() API has been deprecated.

\n

\n", "type": "module", "displayName": "DEP0050: util.isNull()" }, { "textRaw": "DEP0051: util.isNullOrUndefined()", "name": "dep0051:_util.isnullorundefined()", "desc": "

Type: Documentation-only

\n

The util.isNullOrUndefined() API has been deprecated.

\n

\n", "type": "module", "displayName": "DEP0051: util.isNullOrUndefined()" }, { "textRaw": "DEP0052: util.isNumber()", "name": "dep0052:_util.isnumber()", "desc": "

Type: Documentation-only

\n

The util.isNumber() API has been deprecated.

\n

\n", "type": "module", "displayName": "DEP0052: util.isNumber()" }, { "textRaw": "DEP0053 util.isObject()", "name": "dep0053_util.isobject()", "desc": "

Type: Documentation-only

\n

The util.isObject() API has been deprecated.

\n

\n", "type": "module", "displayName": "DEP0053 util.isObject()" }, { "textRaw": "DEP0054: util.isPrimitive()", "name": "dep0054:_util.isprimitive()", "desc": "

Type: Documentation-only

\n

The util.isPrimitive() API has been deprecated.

\n

\n", "type": "module", "displayName": "DEP0054: util.isPrimitive()" }, { "textRaw": "DEP0055: util.isRegExp()", "name": "dep0055:_util.isregexp()", "desc": "

Type: Documentation-only

\n

The util.isRegExp() API has been deprecated.

\n

\n", "type": "module", "displayName": "DEP0055: util.isRegExp()" }, { "textRaw": "DEP0056: util.isString()", "name": "dep0056:_util.isstring()", "desc": "

Type: Documentation-only

\n

The util.isString() API has been deprecated.

\n

\n", "type": "module", "displayName": "DEP0056: util.isString()" }, { "textRaw": "DEP0057: util.isSymbol()", "name": "dep0057:_util.issymbol()", "desc": "

Type: Documentation-only

\n

The util.isSymbol() API has been deprecated.

\n

\n", "type": "module", "displayName": "DEP0057: util.isSymbol()" }, { "textRaw": "DEP0058: util.isUndefined()", "name": "dep0058:_util.isundefined()", "desc": "

Type: Documentation-only

\n

The util.isUndefined() API has been deprecated.

\n

\n", "type": "module", "displayName": "DEP0058: util.isUndefined()" }, { "textRaw": "DEP0059: util.log()", "name": "dep0059:_util.log()", "desc": "

Type: Documentation-only

\n

The util.log() API has been deprecated.

\n

\n", "type": "module", "displayName": "DEP0059: util.log()" }, { "textRaw": "DEP0060: util.\\_extend()", "name": "dep0060:_util.\\_extend()", "desc": "

Type: Documentation-only

\n

The util._extend() API has been deprecated.

\n

\n", "type": "module", "displayName": "DEP0060: util.\\_extend()" }, { "textRaw": "DEP0061: fs.SyncWriteStream", "name": "dep0061:_fs.syncwritestream", "desc": "

Type: Runtime

\n

The fs.SyncWriteStream class was never intended to be a publicly accessible\nAPI. No alternative API is available. Please use a userland alternative.

\n

\n", "type": "module", "displayName": "DEP0061: fs.SyncWriteStream" }, { "textRaw": "DEP0062: node --debug", "name": "dep0062:_node_--debug", "desc": "

Type: Runtime

\n

--debug activates the legacy V8 debugger interface, which has been removed as\nof V8 5.8. It is replaced by Inspector which is activated with --inspect\ninstead.

\n

\n", "type": "module", "displayName": "DEP0062: node --debug" }, { "textRaw": "DEP0063: ServerResponse.prototype.writeHeader()", "name": "dep0063:_serverresponse.prototype.writeheader()", "desc": "

Type: Documentation-only

\n

The http module ServerResponse.prototype.writeHeader() API has been\ndeprecated. Please use ServerResponse.prototype.writeHead() instead.

\n

The ServerResponse.prototype.writeHeader() method was never documented as an\nofficially supported API.

\n

\n", "type": "module", "displayName": "DEP0063: ServerResponse.prototype.writeHeader()" }, { "textRaw": "DEP0064: tls.createSecurePair()", "name": "dep0064:_tls.createsecurepair()", "desc": "

Type: Runtime

\n

The tls.createSecurePair() API was deprecated in documentation in Node.js\n0.11.3. Users should use tls.Socket instead.

\n

\n", "type": "module", "displayName": "DEP0064: tls.createSecurePair()" }, { "textRaw": "DEP0065: repl.REPL_MODE_MAGIC and NODE_REPL_MODE=magic", "name": "dep0065:_repl.repl_mode_magic_and_node_repl_mode=magic", "desc": "

Type: End-of-Life

\n

The repl module's REPL_MODE_MAGIC constant, used for replMode option, has\nbeen 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.

\n

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.

\n

\n", "type": "module", "displayName": "DEP0065: repl.REPL_MODE_MAGIC and NODE_REPL_MODE=magic" }, { "textRaw": "DEP0066: outgoingMessage.\\_headers, outgoingMessage.\\_headerNames", "name": "dep0066:_outgoingmessage.\\_headers,_outgoingmessage.\\_headernames", "desc": "

Type: Documentation-only

\n

The http module outgoingMessage._headers and outgoingMessage._headerNames\nproperties have been deprecated. Please instead use one of the public methods\n(e.g. outgoingMessage.getHeader(), outgoingMessage.getHeaders(),\noutgoingMessage.getHeaderNames(), outgoingMessage.hasHeader(),\noutgoingMessage.removeHeader(), outgoingMessage.setHeader()) for working\nwith outgoing headers.

\n

The outgoingMessage._headers and outgoingMessage._headerNames properties\nwere never documented as officially supported properties.

\n

\n", "type": "module", "displayName": "DEP0066: outgoingMessage.\\_headers, outgoingMessage.\\_headerNames" }, { "textRaw": "DEP0067: OutgoingMessage.prototype.\\_renderHeaders", "name": "dep0067:_outgoingmessage.prototype.\\_renderheaders", "desc": "

Type: Documentation-only

\n

The http module OutgoingMessage.prototype._renderHeaders() API has been\ndeprecated.

\n

The OutgoingMessage.prototype._renderHeaders property was never documented as\nan officially supported API.

\n

\n", "type": "module", "displayName": "DEP0067: OutgoingMessage.prototype.\\_renderHeaders" }, { "textRaw": "DEP0068: node debug", "name": "dep0068:_node_debug", "desc": "

Type: Runtime

\n

node debug corresponds to the legacy CLI debugger which has been replaced with\na V8-inspector based CLI debugger available through node inspect.

\n

\n", "type": "module", "displayName": "DEP0068: node debug" }, { "textRaw": "DEP0069: vm.runInDebugContext(string)", "name": "dep0069:_vm.runindebugcontext(string)", "desc": "

Type: End-of-Life

\n

DebugContext has been removed in V8 and is not available in Node.js 10+.

\n

DebugContext was an experimental API.

\n

\n", "type": "module", "displayName": "DEP0069: vm.runInDebugContext(string)" }, { "textRaw": "DEP0070: async_hooks.currentId()", "name": "dep0070:_async_hooks.currentid()", "desc": "

Type: End-of-Life

\n

async_hooks.currentId() was renamed to async_hooks.executionAsyncId() for\nclarity.

\n

This change was made while async_hooks was an experimental API.

\n

\n", "type": "module", "displayName": "DEP0070: async_hooks.currentId()" }, { "textRaw": "DEP0071: async_hooks.triggerId()", "name": "dep0071:_async_hooks.triggerid()", "desc": "

Type: End-of-Life

\n

async_hooks.triggerId() was renamed to async_hooks.triggerAsyncId() for\nclarity.

\n

This change was made while async_hooks was an experimental API.

\n

\n", "type": "module", "displayName": "DEP0071: async_hooks.triggerId()" }, { "textRaw": "DEP0072: async_hooks.AsyncResource.triggerId()", "name": "dep0072:_async_hooks.asyncresource.triggerid()", "desc": "

Type: End-of-Life

\n

async_hooks.AsyncResource.triggerId() was renamed to\nasync_hooks.AsyncResource.triggerAsyncId() for clarity.

\n

This change was made while async_hooks was an experimental API.

\n

\n", "type": "module", "displayName": "DEP0072: async_hooks.AsyncResource.triggerId()" }, { "textRaw": "DEP0073: Several internal properties of net.Server", "name": "dep0073:_several_internal_properties_of_net.server", "desc": "

Type: End-of-Life

\n

Accessing several internal, undocumented properties of net.Server instances\nwith inappropriate names has been deprecated.

\n

As the original API was undocumented and not generally useful for non-internal\ncode, no replacement API is provided.

\n

\n", "type": "module", "displayName": "DEP0073: Several internal properties of net.Server" }, { "textRaw": "DEP0074: REPLServer.bufferedCommand", "name": "dep0074:_replserver.bufferedcommand", "desc": "

Type: Runtime

\n

The REPLServer.bufferedCommand property was deprecated in favor of\nREPLServer.clearBufferedCommand().

\n

\n", "type": "module", "displayName": "DEP0074: REPLServer.bufferedCommand" }, { "textRaw": "DEP0075: REPLServer.parseREPLKeyword()", "name": "dep0075:_replserver.parsereplkeyword()", "desc": "

Type: Runtime

\n

REPLServer.parseREPLKeyword() was removed from userland visibility.

\n

\n", "type": "module", "displayName": "DEP0075: REPLServer.parseREPLKeyword()" }, { "textRaw": "DEP0076: tls.parseCertString()", "name": "dep0076:_tls.parsecertstring()", "desc": "

Type: Runtime

\n

tls.parseCertString() is a trivial parsing helper that was made public by\nmistake. This function can usually be replaced with:

\n
const querystring = require('querystring');\nquerystring.parse(str, '\\n', '=');\n
\n

This function is not completely equivalent to querystring.parse(). One\ndifference is that querystring.parse() does url decoding:

\n
> querystring.parse('%E5%A5%BD=1', '\\n', '=');\n{ '好': '1' }\n> tls.parseCertString('%E5%A5%BD=1');\n{ '%E5%A5%BD': '1' }\n
\n

\n", "type": "module", "displayName": "DEP0076: tls.parseCertString()" }, { "textRaw": "DEP0077: Module.\\_debug()", "name": "dep0077:_module.\\_debug()", "desc": "

Type: Runtime

\n

Module._debug() has been deprecated.

\n

The Module._debug() function was never documented as an officially\nsupported API.

\n

\n", "type": "module", "displayName": "DEP0077: Module.\\_debug()" }, { "textRaw": "DEP0078: REPLServer.turnOffEditorMode()", "name": "dep0078:_replserver.turnoffeditormode()", "desc": "

Type: Runtime

\n

REPLServer.turnOffEditorMode() was removed from userland visibility.

\n

\n", "type": "module", "displayName": "DEP0078: REPLServer.turnOffEditorMode()" }, { "textRaw": "DEP0079: Custom inspection function on Objects via .inspect()", "name": "dep0079:_custom_inspection_function_on_objects_via_.inspect()", "desc": "

Type: Runtime

\n

Using 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\nmay be specified.

\n

\n", "type": "module", "displayName": "DEP0079: Custom inspection function on Objects via .inspect()" }, { "textRaw": "DEP0080: path.\\_makeLong()", "name": "dep0080:_path.\\_makelong()", "desc": "

Type: Documentation-only

\n

The internal path._makeLong() was not intended for public use. However,\nuserland modules have found it useful. The internal API has been deprecated\nand replaced with an identical, public path.toNamespacedPath() method.

\n

\n", "type": "module", "displayName": "DEP0080: path.\\_makeLong()" }, { "textRaw": "DEP0081: fs.truncate() using a file descriptor", "name": "dep0081:_fs.truncate()_using_a_file_descriptor", "desc": "

Type: Runtime

\n

fs.truncate() fs.truncateSync() usage with a file descriptor has been\ndeprecated. Please use fs.ftruncate() or fs.ftruncateSync() to work with\nfile descriptors.

\n

\n", "type": "module", "displayName": "DEP0081: fs.truncate() using a file descriptor" }, { "textRaw": "DEP0082: REPLServer.prototype.memory()", "name": "dep0082:_replserver.prototype.memory()", "desc": "

Type: Runtime

\n

REPLServer.prototype.memory() is only necessary for the internal mechanics of\nthe REPLServer itself. Do not use this function.

\n

\n", "type": "module", "displayName": "DEP0082: REPLServer.prototype.memory()" }, { "textRaw": "DEP0083: Disabling ECDH by setting ecdhCurve to false", "name": "dep0083:_disabling_ecdh_by_setting_ecdhcurve_to_false", "desc": "

Type: Runtime

\n

The ecdhCurve option to tls.createSecureContext() and tls.TLSSocket could\nbe set to false to disable ECDH entirely on the server only. This mode is\ndeprecated in preparation for migrating to OpenSSL 1.1.0 and consistency with\nthe client. Use the ciphers parameter instead.

\n

\n", "type": "module", "displayName": "DEP0083: Disabling ECDH by setting ecdhCurve to false" }, { "textRaw": "DEP0084: requiring bundled internal dependencies", "name": "dep0084:_requiring_bundled_internal_dependencies", "desc": "

Type: Runtime

\n

Since Node.js versions 4.4.0 and 5.2.0, several modules only intended for\ninternal usage are mistakenly exposed to user code through require(). These\nmodules are:

\n\n

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().

\n

On the other hand, node-inspect may 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.

\n

\n", "type": "module", "displayName": "DEP0084: requiring bundled internal dependencies" }, { "textRaw": "DEP0085: AsyncHooks Sensitive API", "name": "dep0085:_asynchooks_sensitive_api", "desc": "

Type: End-of-Life

\n

The AsyncHooks Sensitive API was never documented and had various minor issues.\n(See https://github.com/nodejs/node/issues/15572.) Use the AsyncResource\nAPI instead.

\n

\n", "type": "module", "displayName": "DEP0085: AsyncHooks Sensitive API" }, { "textRaw": "DEP0086: Remove runInAsyncIdScope", "name": "dep0086:_remove_runinasyncidscope", "desc": "

Type: End-of-Life

\n

runInAsyncIdScope doesn't emit the 'before' or 'after' event and can thus\ncause a lot of issues. See https://github.com/nodejs/node/issues/14328 for more\ndetails.

\n

\n", "type": "module", "displayName": "DEP0086: Remove runInAsyncIdScope" }, { "textRaw": "DEP0089: require('assert')", "name": "dep0089:_require('assert')", "desc": "

Type: Documentation-only

\n

Importing assert directly is not recommended as the exposed functions will use\nloose equality checks. Use require('assert').strict instead. The API is the\nsame as the legacy assert but it will always use strict equality checks.

\n

\n", "type": "module", "displayName": "DEP0089: require('assert')" }, { "textRaw": "DEP0090: Invalid GCM authentication tag lengths", "name": "dep0090:_invalid_gcm_authentication_tag_lengths", "desc": "

Type: Runtime

\n

Node.js supports all GCM authentication tag lengths which are accepted by\nOpenSSL when calling decipher.setAuthTag(). This behavior will change in\na future version at which point only authentication tag lengths of 128, 120,\n112, 104, 96, 64, and 32 bits will be allowed. Authentication tags whose length\nis not included in this list will be considered invalid in compliance with\nNIST SP 800-38D.

\n

\n", "type": "module", "displayName": "DEP0090: Invalid GCM authentication tag lengths" }, { "textRaw": "DEP0091: crypto.DEFAULT_ENCODING", "name": "dep0091:_crypto.default_encoding", "desc": "

Type: Runtime

\n

The crypto.DEFAULT_ENCODING property is deprecated.

\n

\n", "type": "module", "displayName": "DEP0091: crypto.DEFAULT_ENCODING" }, { "textRaw": "DEP0092: Top-level `this` bound to `module.exports`", "name": "dep0092:_top-level_`this`_bound_to_`module.exports`", "desc": "

Type: Documentation-only

\n

Assigning properties to the top-level this as an alternative\nto module.exports is deprecated. Developers should use exports\nor module.exports instead.

\n

\n", "type": "module", "displayName": "DEP0092: Top-level `this` bound to `module.exports`" }, { "textRaw": "DEP0093: crypto.fips is deprecated and replaced.", "name": "dep0093:_crypto.fips_is_deprecated_and_replaced.", "desc": "

Type: Documentation-only

\n

The crypto.fips property is deprecated. Please use crypto.setFips()\nand crypto.getFips() instead.

\n

\n", "type": "module", "displayName": "DEP0093: crypto.fips is deprecated and replaced." }, { "textRaw": "DEP0094: Using `assert.fail()` with more than one argument.", "name": "dep0094:_using_`assert.fail()`_with_more_than_one_argument.", "desc": "

Type: Runtime

\n

Using assert.fail() with more than one argument is deprecated. Use\nassert.fail() with only one argument or use a different assert module\nmethod.

\n

\n", "type": "module", "displayName": "DEP0094: Using `assert.fail()` with more than one argument." }, { "textRaw": "DEP0095: timers.enroll()", "name": "dep0095:_timers.enroll()", "desc": "

Type: Runtime

\n

timers.enroll() is deprecated. Please use the publicly documented\nsetTimeout() or setInterval() instead.

\n

\n", "type": "module", "displayName": "DEP0095: timers.enroll()" }, { "textRaw": "DEP0096: timers.unenroll()", "name": "dep0096:_timers.unenroll()", "desc": "

Type: Runtime

\n

timers.unenroll() is deprecated. Please use the publicly documented\nclearTimeout() or clearInterval() instead.

\n

\n", "type": "module", "displayName": "DEP0096: timers.unenroll()" }, { "textRaw": "DEP0097: MakeCallback with domain property", "name": "dep0097:_makecallback_with_domain_property", "desc": "

Type: Runtime

\n

Users 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.

\n

\n", "type": "module", "displayName": "DEP0097: MakeCallback with domain property" }, { "textRaw": "DEP0098: AsyncHooks Embedder AsyncResource.emitBefore and AsyncResource.emitAfter APIs", "name": "dep0098:_asynchooks_embedder_asyncresource.emitbefore_and_asyncresource.emitafter_apis", "desc": "

Type: Runtime

\n

The embedded API provided by AsyncHooks exposes .emitBefore() and\n.emitAfter() methods which are very easy to use incorrectly which can lead\nto unrecoverable errors.

\n

Use asyncResource.runInAsyncScope() API instead which provides a much\nsafer, and more convenient, alternative. See\nhttps://github.com/nodejs/node/pull/18513 for more details.

\n

\n", "type": "module", "displayName": "DEP0098: AsyncHooks Embedder AsyncResource.emitBefore and AsyncResource.emitAfter APIs" }, { "textRaw": "DEP0099: async context-unaware node::MakeCallback C++ APIs", "name": "dep0099:_async_context-unaware_node::makecallback_c++_apis", "desc": "

Type: Compile-time

\n

Certain versions of node::MakeCallback APIs available to native modules are\ndeprecated. Please use the versions of the API that accept an async_context\nparameter.

\n

\n", "type": "module", "displayName": "DEP0099: async context-unaware node::MakeCallback C++ APIs" }, { "textRaw": "DEP0100: process.assert()", "name": "dep0100:_process.assert()", "desc": "

Type: Runtime

\n

process.assert() is deprecated. Please use the assert module instead.

\n

This was never a documented feature.

\n

\n", "type": "module", "displayName": "DEP0100: process.assert()" }, { "textRaw": "DEP0101: --with-lttng", "name": "dep0101:_--with-lttng", "desc": "

Type: End-of-Life

\n

The --with-lttng compile-time option has been removed.

\n

\n", "type": "module", "displayName": "DEP0101: --with-lttng" }, { "textRaw": "DEP0102: Using `noAssert` in Buffer#(read|write) operations.", "name": "dep0102:_using_`noassert`_in_buffer#(read|write)_operations.", "desc": "

Type: End-of-Life

\n

Using the noAssert argument has no functionality anymore. All input is going\nto be verified, no matter if it is set to true or not. Skipping the verification\ncould lead to hard to find errors and crashes.

\n

\n", "type": "module", "displayName": "DEP0102: Using `noAssert` in Buffer#(read|write) operations." }, { "textRaw": "DEP0103: process.binding('util').is[...] typechecks", "name": "dep0103:_process.binding('util').is[...]_typechecks", "desc": "

Type: Documentation-only (supports --pending-deprecation)

\n

Using process.binding() in general should be avoided. The type checking\nmethods in particular can be replaced by using util.types.

\n

\n", "type": "module", "displayName": "DEP0103: process.binding('util').is[...] typechecks" }, { "textRaw": "DEP0104: process.env string coercion", "name": "dep0104:_process.env_string_coercion", "desc": "

Type: Documentation-only (supports --pending-deprecation)

\n

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 may\nresult in a thrown error. Please convert the property to a string before\nassigning it to process.env.

\n

\n", "type": "module", "displayName": "DEP0104: process.env string coercion" }, { "textRaw": "DEP0105: decipher.finaltol", "name": "dep0105:_decipher.finaltol", "desc": "

Type: Runtime

\n

decipher.finaltol() has never been documented and is currently an alias for\ndecipher.final(). In the future, this API will likely be removed, and it\nis recommended to use decipher.final() instead.

\n

\n", "type": "module", "displayName": "DEP0105: decipher.finaltol" }, { "textRaw": "DEP0106: crypto.createCipher and crypto.createDecipher", "name": "dep0106:_crypto.createcipher_and_crypto.createdecipher", "desc": "

Type: Documentation-only

\n

Using crypto.createCipher() and crypto.createDecipher() should 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() and to use crypto.createCipheriv() and\ncrypto.createDecipheriv() to obtain the Cipher and Decipher\nobjects respectively.

\n

\n", "type": "module", "displayName": "DEP0106: crypto.createCipher and crypto.createDecipher" }, { "textRaw": "DEP0107: tls.convertNPNProtocols()", "name": "dep0107:_tls.convertnpnprotocols()", "desc": "

Type: Runtime

\n

This was an undocumented helper function not intended for use outside Node.js\ncore and obsoleted by the removal of NPN (Next Protocol Negotiation) support.

\n

\n", "type": "module", "displayName": "DEP0107: tls.convertNPNProtocols()" }, { "textRaw": "DEP0108: zlib.bytesRead", "name": "dep0108:_zlib.bytesread", "desc": "

Type: Documentation-only

\n

Deprecated 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.

\n", "type": "module", "displayName": "DEP0108: zlib.bytesRead" } ], "type": "misc", "displayName": "List of Deprecated APIs" } ] } ] }