diff options
| author | Сковорода Никита Андреевич <chalkerx@gmail.com> | 2018-01-29 20:23:09 +0300 |
|---|---|---|
| committer | Сковорода Никита Андреевич <chalkerx@gmail.com> | 2018-01-31 01:22:43 +0300 |
| commit | 4efde4d0d4934dd8b47c11011e47eb27ad78a7ae (patch) | |
| tree | d062d9ab5d6838d2b360c384486d898cf1b00df6 /doc | |
| parent | c276851b2f0074a7402115d5336737f84726fa9c (diff) | |
| download | android-node-v8-4efde4d0d4934dd8b47c11011e47eb27ad78a7ae.tar.gz android-node-v8-4efde4d0d4934dd8b47c11011e47eb27ad78a7ae.tar.bz2 android-node-v8-4efde4d0d4934dd8b47c11011e47eb27ad78a7ae.zip | |
doc: add pending-deprecation to deprecations list
This adds a mention of `--pending-deprecation` flag effect
in the Deprecated APIs document, and explicitly labels
deprecations that support it.
Refs: https://github.com/nodejs/node/issues/18417
PR-URL: https://github.com/nodejs/node/pull/18433
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/deprecations.md | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index e38c29949c..de2f42cd0e 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -14,6 +14,12 @@ Node.js utilizes three kinds of Deprecations: A Documentation-only deprecation is one that is expressed only within the Node.js API docs. These generate no side-effects while running Node.js. +Some Documentation-only deprecations trigger a runtime warning when launched +with [`--pending-deprecation`][] flag (or its alternative, +`NODE_PENDING_DEPRECATION=1` environment variable), similarly to Runtime +deprecations below. Documentation-only deprecations that support that flag +are explicitly labeled as such in the +[list of Deprecated APIs](#deprecations_list_of_deprecated_apis). A Runtime deprecation will, by default, generate a process warning that will be printed to `stderr` the first time the deprecated API is used. When the @@ -66,7 +72,7 @@ be used. <a id="DEP0005"></a> ### DEP0005: Buffer() constructor -Type: Documentation-only +Type: Documentation-only (supports [`--pending-deprecation`][]) The `Buffer()` function and `new Buffer()` constructor are deprecated due to API usability issues that can potentially lead to accidental security issues. @@ -818,6 +824,7 @@ a future version at which point only authentication tag lengths of 128, 120, is not included in this list will be considered invalid in compliance with [NIST SP 800-38D][]. +[`--pending-deprecation`]: cli.html#cli_pending_deprecation [`Buffer.allocUnsafeSlow(size)`]: buffer.html#buffer_class_method_buffer_allocunsafeslow_size [`Buffer.from(array)`]: buffer.html#buffer_class_method_buffer_from_array [`Buffer.from(buffer)`]: buffer.html#buffer_class_method_buffer_from_buffer |