Skip to content

Commit 1c7f221

Browse files
committed
doc: adding deprecations.md
PR-URL: #11621 Reviewed-By: Sam Roberts <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent 3e8d43d commit 1c7f221

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

doc/api/deprecations.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Deprecated APIs
2+
3+
Node.js may deprecate APIs when either: (a) use of the API is considered to be
4+
unsafe, (b) an improved alternative API has been made available, or (c)
5+
breaking changes to the API are expected in a future major release.
6+
7+
Node.js utilizes three kinds of Deprecations:
8+
9+
* Documentation-only
10+
* Runtime
11+
* End-of-Life
12+
13+
A Documentation-only deprecation is one that is expressed only within the
14+
Node.js API docs. These generate no side-effects while running Node.js.
15+
16+
A Runtime deprecation will, by default, generate a process warning that will
17+
be printed to `stderr` the first time the deprecated API is used. When the
18+
`--throw-deprecation` command-line flag is used, a Runtime deprecation will
19+
cause an error to be thrown.
20+
21+
An End-of-Life deprecation is used to identify code that either has been
22+
removed or will soon be removed from Node.js.
23+
24+
## Un-deprecation
25+
26+
From time-to-time the deprecation of an API may be reversed. Such action may
27+
happen in either a semver-minor or semver-major release. In such situations,
28+
this document will be updated with information relevant to the decision.
29+
*However, the deprecation identifier will not be modified*.
30+
31+
## List of Deprecated APIs
32+
33+
<a id="DEP0062"></a>
34+
### DEP0062: node --debug
35+
36+
Type: Runtime
37+
38+
`--debug` activates the legacy V8 debugger interface, which has been removed as
39+
of V8 5.8. It is replaced by Inspector which is activated with `--inspect`
40+
instead.

0 commit comments

Comments
 (0)