Commit fe832a0
doc: update the deprecation for exit code to clarify its scope
This updates the deprecation, DEP0164, to clarify its scope.
Previously, `process.exitCode` wasn't mentioned but it needs
to be applied with the same deprecation because its meaning
is the same as the `code` value and it's overridden with the
`code` value in `process.exit()`.
Signed-off-by: Daeyeon Jeong <daeyeon.dev@gmail.com>
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
PR-URL: #44714
Refs: #44712
Refs: #43738
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>1 parent 2cee039 commit fe832a0
1 file changed
Lines changed: 11 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -3120,19 +3120,25 @@ Use [`diagnostics_channel.subscribe(name, onMessage)`][] or | |||
| 3120 | 3120 | [`diagnostics_channel.unsubscribe(name, onMessage)`][] which does the same | |
| 3121 | 3121 | thing instead. | |
| 3122 | 3122 | ||
| 3123 | - ### DEP0164: `process.exit([code])` coercion to integer | ||
| 3123 | + ### DEP0164: `process.exit(code)`, `process.exitCode` coercion to integer | ||
| 3124 | 3124 | ||
| 3125 | 3125 | <!-- YAML | |
| 3126 | 3126 | changes: | |
| 3127 | + - version: REPLACEME | ||
| 3128 | + pr-url: https://github.com/nodejs/node/pull/44714 | ||
| 3129 | + description: Documentation-only deprecation of `process.exitCode` integer | ||
| 3130 | + coercion. | ||
| 3127 | 3131 | - version: v16.17.0 | |
| 3128 | 3132 | pr-url: https://github.com/nodejs/node/pull/43738 | |
| 3129 | - description: Documentation-only deprecation. | ||
| 3133 | + description: Documentation-only deprecation of `process.exit(code)` integer | ||
| 3134 | + coercion. | ||
| 3130 | 3135 | --> | |
| 3131 | 3136 | ||
| 3132 | 3137 | Type: Documentation-only | |
| 3133 | 3138 | ||
| 3134 | - `code` values other than `undefined`, `null`, integer numbers and integer | ||
| 3135 | - strings (e.g., '1') are deprecated as parameter in [`process.exit()`][]. | ||
| 3139 | + Values other than `undefined`, `null`, integer numbers, and integer strings | ||
| 3140 | + (e.g., `'1'`) are deprecated as value for the `code` parameter in | ||
| 3141 | + [`process.exit()`][] and as value to assign to [`process.exitCode`][]. | ||
| 3136 | 3142 | ||
| 3137 | 3143 | ### DEP0165: `--trace-atomics-wait` | |
| 3138 | 3144 | ||
@@ -3246,6 +3252,7 @@ rely on these groups should evaluate using stronger MODP groups instead. | |||
| 3246 | 3252 | [`os.tmpdir()`]: os.md#ostmpdir | |
| 3247 | 3253 | [`process.env`]: process.md#processenv | |
| 3248 | 3254 | [`process.exit()`]: process.md#processexitcode | |
| 3255 | + [`process.exitCode`]: process.md#processexitcode_1 | ||
| 3249 | 3256 | [`process.getActiveResourcesInfo()`]: process.md#processgetactiveresourcesinfo | |
| 3250 | 3257 | [`process.mainModule`]: process.md#processmainmodule | |
| 3251 | 3258 | [`punycode`]: punycode.md | |
0 commit comments