@@ -14,6 +14,12 @@ Node.js utilizes three kinds of Deprecations:
14
14
15
15
A Documentation-only deprecation is one that is expressed only within the
16
16
Node.js API docs. These generate no side-effects while running Node.js.
17
+ Some Documentation-only deprecations trigger a runtime warning when launched
18
+ with [ ` --pending-deprecation ` ] [ ] flag (or its alternative,
19
+ ` NODE_PENDING_DEPRECATION=1 ` environment variable), similarly to Runtime
20
+ deprecations below. Documentation-only deprecations that support that flag
21
+ are explicitly labeled as such in the
22
+ [ list of Deprecated APIs] ( #deprecations_list_of_deprecated_apis ) .
17
23
18
24
A Runtime deprecation will, by default, generate a process warning that will
19
25
be printed to ` stderr ` the first time the deprecated API is used. When the
@@ -66,7 +72,7 @@ be used.
66
72
<a id =" DEP0005 " ></a >
67
73
### DEP0005: Buffer() constructor
68
74
69
- Type: Documentation-only
75
+ Type: Documentation-only (supports [ ` --pending-deprecation ` ] [ ] )
70
76
71
77
The ` Buffer() ` function and ` new Buffer() ` constructor are deprecated due to
72
78
API usability issues that can potentially lead to accidental security issues.
@@ -780,6 +786,7 @@ Use [`asyncResource.runInAsyncScope()`][] API instead which provides a much
780
786
safer, and more convenient, alternative. See
781
787
https://github.com/nodejs/node/pull/18513 for more details.
782
788
789
+ [`--pending-deprecation`]: cli.html#cli_pending_deprecation
783
790
[`Buffer.allocUnsafeSlow(size)`]: buffer.html#buffer_class_method_buffer_allocunsafeslow_size
784
791
[`Buffer.from(array)`]: buffer.html#buffer_class_method_buffer_from_array
785
792
[`Buffer.from(buffer)`]: buffer.html#buffer_class_method_buffer_from_buffer
0 commit comments