doc: use "is" rather than "has been"
In deprecations.md, there are many uses of "has been" that are mildly awkward. This changes several instances of things like "fhqwhgads() has been deprecated" to "fhqwhgads() is deprecated". Especially for non-native speakers, present tense is generally easier to read and understand than past participles. (Or at least that's my experience reading things in languages other than English.) PR-URL: https://github.com/nodejs/node/pull/21043 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
This commit is contained in:
Rich Trott
parent
dce6d53e6b
commit
42dbb60819
@ -4,8 +4,8 @@
|
|||||||
<!-- type=misc -->
|
<!-- type=misc -->
|
||||||
|
|
||||||
Node.js may deprecate APIs when either: (a) use of the API is considered to be
|
Node.js may deprecate APIs when either: (a) use of the API is considered to be
|
||||||
unsafe, (b) an improved alternative API has been made available, or (c)
|
unsafe, (b) an improved alternative API is available, or (c) breaking changes to
|
||||||
breaking changes to the API are expected in a future major release.
|
the API are expected in a future major release.
|
||||||
|
|
||||||
Node.js utilizes three kinds of Deprecations:
|
Node.js utilizes three kinds of Deprecations:
|
||||||
|
|
||||||
@ -27,8 +27,8 @@ be printed to `stderr` the first time the deprecated API is used. When the
|
|||||||
`--throw-deprecation` command-line flag is used, a Runtime deprecation will
|
`--throw-deprecation` command-line flag is used, a Runtime deprecation will
|
||||||
cause an error to be thrown.
|
cause an error to be thrown.
|
||||||
|
|
||||||
An End-of-Life deprecation is used to identify code that either has been
|
An End-of-Life deprecation is used when functionality is or will soon be removed
|
||||||
removed or will soon be removed from Node.js.
|
from Node.js.
|
||||||
|
|
||||||
## Revoking deprecations
|
## Revoking deprecations
|
||||||
|
|
||||||
@ -123,7 +123,7 @@ precisely describe the actual semantics and was unnecessarily emotion-laden.
|
|||||||
|
|
||||||
Type: Documentation-only
|
Type: Documentation-only
|
||||||
|
|
||||||
The `constants` module has been deprecated. When requiring access to constants
|
The `constants` module is deprecated. When requiring access to constants
|
||||||
relevant to specific Node.js builtin modules, developers should instead refer
|
relevant to specific Node.js builtin modules, developers should instead refer
|
||||||
to the `constants` property exposed by the relevant module. For instance,
|
to the `constants` property exposed by the relevant module. For instance,
|
||||||
`require('fs').constants` and `require('os').constants`.
|
`require('fs').constants` and `require('os').constants`.
|
||||||
@ -303,7 +303,7 @@ instead.
|
|||||||
|
|
||||||
Type: Documentation-only
|
Type: Documentation-only
|
||||||
|
|
||||||
The [`SlowBuffer`][] class has been deprecated. Please use
|
The [`SlowBuffer`][] class is deprecated. Please use
|
||||||
[`Buffer.allocUnsafeSlow(size)`][] instead.
|
[`Buffer.allocUnsafeSlow(size)`][] instead.
|
||||||
|
|
||||||
<a id="DEP0031"></a>
|
<a id="DEP0031"></a>
|
||||||
@ -326,7 +326,7 @@ The [`domain`][] module is deprecated and should not be used.
|
|||||||
|
|
||||||
Type: Documentation-only
|
Type: Documentation-only
|
||||||
|
|
||||||
The [`EventEmitter.listenerCount(emitter, eventName)`][] API has been
|
The [`EventEmitter.listenerCount(emitter, eventName)`][] API is
|
||||||
deprecated. Please use [`emitter.listenerCount(eventName)`][] instead.
|
deprecated. Please use [`emitter.listenerCount(eventName)`][] instead.
|
||||||
|
|
||||||
<a id="DEP0034"></a>
|
<a id="DEP0034"></a>
|
||||||
@ -334,7 +334,7 @@ deprecated. Please use [`emitter.listenerCount(eventName)`][] instead.
|
|||||||
|
|
||||||
Type: Documentation-only
|
Type: Documentation-only
|
||||||
|
|
||||||
The [`fs.exists(path, callback)`][] API has been deprecated. Please use
|
The [`fs.exists(path, callback)`][] API is deprecated. Please use
|
||||||
[`fs.stat()`][] or [`fs.access()`][] instead.
|
[`fs.stat()`][] or [`fs.access()`][] instead.
|
||||||
|
|
||||||
<a id="DEP0035"></a>
|
<a id="DEP0035"></a>
|
||||||
@ -342,42 +342,42 @@ The [`fs.exists(path, callback)`][] API has been deprecated. Please use
|
|||||||
|
|
||||||
Type: Documentation-only
|
Type: Documentation-only
|
||||||
|
|
||||||
The [`fs.lchmod(path, mode, callback)`][] API has been deprecated.
|
The [`fs.lchmod(path, mode, callback)`][] API is deprecated.
|
||||||
|
|
||||||
<a id="DEP0036"></a>
|
<a id="DEP0036"></a>
|
||||||
### DEP0036: fs.lchmodSync(path, mode)
|
### DEP0036: fs.lchmodSync(path, mode)
|
||||||
|
|
||||||
Type: Documentation-only
|
Type: Documentation-only
|
||||||
|
|
||||||
The [`fs.lchmodSync(path, mode)`][] API has been deprecated.
|
The [`fs.lchmodSync(path, mode)`][] API is deprecated.
|
||||||
|
|
||||||
<a id="DEP0037"></a>
|
<a id="DEP0037"></a>
|
||||||
### DEP0037: fs.lchown(path, uid, gid, callback)
|
### DEP0037: fs.lchown(path, uid, gid, callback)
|
||||||
|
|
||||||
Type: Documentation-only
|
Type: Documentation-only
|
||||||
|
|
||||||
The [`fs.lchown(path, uid, gid, callback)`][] API has been deprecated.
|
The [`fs.lchown(path, uid, gid, callback)`][] API is deprecated.
|
||||||
|
|
||||||
<a id="DEP0038"></a>
|
<a id="DEP0038"></a>
|
||||||
### DEP0038: fs.lchownSync(path, uid, gid)
|
### DEP0038: fs.lchownSync(path, uid, gid)
|
||||||
|
|
||||||
Type: Documentation-only
|
Type: Documentation-only
|
||||||
|
|
||||||
The [`fs.lchownSync(path, uid, gid)`][] API has been deprecated.
|
The [`fs.lchownSync(path, uid, gid)`][] API is deprecated.
|
||||||
|
|
||||||
<a id="DEP0039"></a>
|
<a id="DEP0039"></a>
|
||||||
### DEP0039: require.extensions
|
### DEP0039: require.extensions
|
||||||
|
|
||||||
Type: Documentation-only
|
Type: Documentation-only
|
||||||
|
|
||||||
The [`require.extensions`][] property has been deprecated.
|
The [`require.extensions`][] property is deprecated.
|
||||||
|
|
||||||
<a id="DEP0040"></a>
|
<a id="DEP0040"></a>
|
||||||
### DEP0040: punycode module
|
### DEP0040: punycode module
|
||||||
|
|
||||||
Type: Documentation-only
|
Type: Documentation-only
|
||||||
|
|
||||||
The [`punycode`][] module has been deprecated. Please use a userland alternative
|
The [`punycode`][] module is deprecated. Please use a userland alternative
|
||||||
instead.
|
instead.
|
||||||
|
|
||||||
<a id="DEP0041"></a>
|
<a id="DEP0041"></a>
|
||||||
@ -393,7 +393,7 @@ The `NODE_REPL_HISTORY_FILE` environment variable was removed. Please use
|
|||||||
|
|
||||||
Type: Documentation-only
|
Type: Documentation-only
|
||||||
|
|
||||||
The [`tls.CryptoStream`][] class has been deprecated. Please use
|
The [`tls.CryptoStream`][] class is deprecated. Please use
|
||||||
[`tls.TLSSocket`][] instead.
|
[`tls.TLSSocket`][] instead.
|
||||||
|
|
||||||
<a id="DEP0043"></a>
|
<a id="DEP0043"></a>
|
||||||
@ -401,7 +401,7 @@ The [`tls.CryptoStream`][] class has been deprecated. Please use
|
|||||||
|
|
||||||
Type: Documentation-only
|
Type: Documentation-only
|
||||||
|
|
||||||
The [`tls.SecurePair`][] class has been deprecated. Please use
|
The [`tls.SecurePair`][] class is deprecated. Please use
|
||||||
[`tls.TLSSocket`][] instead.
|
[`tls.TLSSocket`][] instead.
|
||||||
|
|
||||||
<a id="DEP0044"></a>
|
<a id="DEP0044"></a>
|
||||||
@ -409,7 +409,7 @@ The [`tls.SecurePair`][] class has been deprecated. Please use
|
|||||||
|
|
||||||
Type: Documentation-only
|
Type: Documentation-only
|
||||||
|
|
||||||
The [`util.isArray()`][] API has been deprecated. Please use `Array.isArray()`
|
The [`util.isArray()`][] API is deprecated. Please use `Array.isArray()`
|
||||||
instead.
|
instead.
|
||||||
|
|
||||||
<a id="DEP0045"></a>
|
<a id="DEP0045"></a>
|
||||||
@ -417,14 +417,14 @@ instead.
|
|||||||
|
|
||||||
Type: Documentation-only
|
Type: Documentation-only
|
||||||
|
|
||||||
The [`util.isBoolean()`][] API has been deprecated.
|
The [`util.isBoolean()`][] API is deprecated.
|
||||||
|
|
||||||
<a id="DEP0046"></a>
|
<a id="DEP0046"></a>
|
||||||
### DEP0046: util.isBuffer()
|
### DEP0046: util.isBuffer()
|
||||||
|
|
||||||
Type: Documentation-only
|
Type: Documentation-only
|
||||||
|
|
||||||
The [`util.isBuffer()`][] API has been deprecated. Please use
|
The [`util.isBuffer()`][] API is deprecated. Please use
|
||||||
[`Buffer.isBuffer()`][] instead.
|
[`Buffer.isBuffer()`][] instead.
|
||||||
|
|
||||||
<a id="DEP0047"></a>
|
<a id="DEP0047"></a>
|
||||||
@ -432,98 +432,98 @@ The [`util.isBuffer()`][] API has been deprecated. Please use
|
|||||||
|
|
||||||
Type: Documentation-only
|
Type: Documentation-only
|
||||||
|
|
||||||
The [`util.isDate()`][] API has been deprecated.
|
The [`util.isDate()`][] API is deprecated.
|
||||||
|
|
||||||
<a id="DEP0048"></a>
|
<a id="DEP0048"></a>
|
||||||
### DEP0048: util.isError()
|
### DEP0048: util.isError()
|
||||||
|
|
||||||
Type: Documentation-only
|
Type: Documentation-only
|
||||||
|
|
||||||
The [`util.isError()`][] API has been deprecated.
|
The [`util.isError()`][] API is deprecated.
|
||||||
|
|
||||||
<a id="DEP0049"></a>
|
<a id="DEP0049"></a>
|
||||||
### DEP0049: util.isFunction()
|
### DEP0049: util.isFunction()
|
||||||
|
|
||||||
Type: Documentation-only
|
Type: Documentation-only
|
||||||
|
|
||||||
The [`util.isFunction()`][] API has been deprecated.
|
The [`util.isFunction()`][] API is deprecated.
|
||||||
|
|
||||||
<a id="DEP0050"></a>
|
<a id="DEP0050"></a>
|
||||||
### DEP0050: util.isNull()
|
### DEP0050: util.isNull()
|
||||||
|
|
||||||
Type: Documentation-only
|
Type: Documentation-only
|
||||||
|
|
||||||
The [`util.isNull()`][] API has been deprecated.
|
The [`util.isNull()`][] API is deprecated.
|
||||||
|
|
||||||
<a id="DEP0051"></a>
|
<a id="DEP0051"></a>
|
||||||
### DEP0051: util.isNullOrUndefined()
|
### DEP0051: util.isNullOrUndefined()
|
||||||
|
|
||||||
Type: Documentation-only
|
Type: Documentation-only
|
||||||
|
|
||||||
The [`util.isNullOrUndefined()`][] API has been deprecated.
|
The [`util.isNullOrUndefined()`][] API is deprecated.
|
||||||
|
|
||||||
<a id="DEP0052"></a>
|
<a id="DEP0052"></a>
|
||||||
### DEP0052: util.isNumber()
|
### DEP0052: util.isNumber()
|
||||||
|
|
||||||
Type: Documentation-only
|
Type: Documentation-only
|
||||||
|
|
||||||
The [`util.isNumber()`][] API has been deprecated.
|
The [`util.isNumber()`][] API is deprecated.
|
||||||
|
|
||||||
<a id="DEP0053"></a>
|
<a id="DEP0053"></a>
|
||||||
### DEP0053 util.isObject()
|
### DEP0053 util.isObject()
|
||||||
|
|
||||||
Type: Documentation-only
|
Type: Documentation-only
|
||||||
|
|
||||||
The [`util.isObject()`][] API has been deprecated.
|
The [`util.isObject()`][] API is deprecated.
|
||||||
|
|
||||||
<a id="DEP0054"></a>
|
<a id="DEP0054"></a>
|
||||||
### DEP0054: util.isPrimitive()
|
### DEP0054: util.isPrimitive()
|
||||||
|
|
||||||
Type: Documentation-only
|
Type: Documentation-only
|
||||||
|
|
||||||
The [`util.isPrimitive()`][] API has been deprecated.
|
The [`util.isPrimitive()`][] API is deprecated.
|
||||||
|
|
||||||
<a id="DEP0055"></a>
|
<a id="DEP0055"></a>
|
||||||
### DEP0055: util.isRegExp()
|
### DEP0055: util.isRegExp()
|
||||||
|
|
||||||
Type: Documentation-only
|
Type: Documentation-only
|
||||||
|
|
||||||
The [`util.isRegExp()`][] API has been deprecated.
|
The [`util.isRegExp()`][] API is deprecated.
|
||||||
|
|
||||||
<a id="DEP0056"></a>
|
<a id="DEP0056"></a>
|
||||||
### DEP0056: util.isString()
|
### DEP0056: util.isString()
|
||||||
|
|
||||||
Type: Documentation-only
|
Type: Documentation-only
|
||||||
|
|
||||||
The [`util.isString()`][] API has been deprecated.
|
The [`util.isString()`][] API is deprecated.
|
||||||
|
|
||||||
<a id="DEP0057"></a>
|
<a id="DEP0057"></a>
|
||||||
### DEP0057: util.isSymbol()
|
### DEP0057: util.isSymbol()
|
||||||
|
|
||||||
Type: Documentation-only
|
Type: Documentation-only
|
||||||
|
|
||||||
The [`util.isSymbol()`][] API has been deprecated.
|
The [`util.isSymbol()`][] API is deprecated.
|
||||||
|
|
||||||
<a id="DEP0058"></a>
|
<a id="DEP0058"></a>
|
||||||
### DEP0058: util.isUndefined()
|
### DEP0058: util.isUndefined()
|
||||||
|
|
||||||
Type: Documentation-only
|
Type: Documentation-only
|
||||||
|
|
||||||
The [`util.isUndefined()`][] API has been deprecated.
|
The [`util.isUndefined()`][] API is deprecated.
|
||||||
|
|
||||||
<a id="DEP0059"></a>
|
<a id="DEP0059"></a>
|
||||||
### DEP0059: util.log()
|
### DEP0059: util.log()
|
||||||
|
|
||||||
Type: Documentation-only
|
Type: Documentation-only
|
||||||
|
|
||||||
The [`util.log()`][] API has been deprecated.
|
The [`util.log()`][] API is deprecated.
|
||||||
|
|
||||||
<a id="DEP0060"></a>
|
<a id="DEP0060"></a>
|
||||||
### DEP0060: util.\_extend()
|
### DEP0060: util.\_extend()
|
||||||
|
|
||||||
Type: Documentation-only
|
Type: Documentation-only
|
||||||
|
|
||||||
The [`util._extend()`][] API has been deprecated.
|
The [`util._extend()`][] API is deprecated.
|
||||||
|
|
||||||
<a id="DEP0061"></a>
|
<a id="DEP0061"></a>
|
||||||
### DEP0061: fs.SyncWriteStream
|
### DEP0061: fs.SyncWriteStream
|
||||||
@ -539,7 +539,7 @@ alternative.
|
|||||||
|
|
||||||
Type: Runtime
|
Type: Runtime
|
||||||
|
|
||||||
`--debug` activates the legacy V8 debugger interface, which has been removed as
|
`--debug` activates the legacy V8 debugger interface, which was removed as
|
||||||
of V8 5.8. It is replaced by Inspector which is activated with `--inspect`
|
of V8 5.8. It is replaced by Inspector which is activated with `--inspect`
|
||||||
instead.
|
instead.
|
||||||
|
|
||||||
@ -548,7 +548,7 @@ instead.
|
|||||||
|
|
||||||
Type: Documentation-only
|
Type: Documentation-only
|
||||||
|
|
||||||
The `http` module `ServerResponse.prototype.writeHeader()` API has been
|
The `http` module `ServerResponse.prototype.writeHeader()` API is
|
||||||
deprecated. Please use `ServerResponse.prototype.writeHead()` instead.
|
deprecated. Please use `ServerResponse.prototype.writeHead()` instead.
|
||||||
|
|
||||||
The `ServerResponse.prototype.writeHeader()` method was never documented as an
|
The `ServerResponse.prototype.writeHeader()` method was never documented as an
|
||||||
@ -596,7 +596,7 @@ were never documented as officially supported properties.
|
|||||||
|
|
||||||
Type: Documentation-only
|
Type: Documentation-only
|
||||||
|
|
||||||
The `http` module `OutgoingMessage.prototype._renderHeaders()` API has been
|
The `http` module `OutgoingMessage.prototype._renderHeaders()` API is
|
||||||
deprecated.
|
deprecated.
|
||||||
|
|
||||||
The `OutgoingMessage.prototype._renderHeaders` property was never documented as
|
The `OutgoingMessage.prototype._renderHeaders` property was never documented as
|
||||||
@ -655,7 +655,7 @@ This change was made while `async_hooks` was an experimental API.
|
|||||||
Type: End-of-Life
|
Type: End-of-Life
|
||||||
|
|
||||||
Accessing several internal, undocumented properties of `net.Server` instances
|
Accessing several internal, undocumented properties of `net.Server` instances
|
||||||
with inappropriate names has been deprecated.
|
with inappropriate names is deprecated.
|
||||||
|
|
||||||
As the original API was undocumented and not generally useful for non-internal
|
As the original API was undocumented and not generally useful for non-internal
|
||||||
code, no replacement API is provided.
|
code, no replacement API is provided.
|
||||||
@ -703,7 +703,7 @@ difference is that `querystring.parse()` does url decoding:
|
|||||||
|
|
||||||
Type: Runtime
|
Type: Runtime
|
||||||
|
|
||||||
`Module._debug()` has been deprecated.
|
`Module._debug()` is deprecated.
|
||||||
|
|
||||||
The `Module._debug()` function was never documented as an officially
|
The `Module._debug()` function was never documented as an officially
|
||||||
supported API.
|
supported API.
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user