Skip to content

Commit 014eb67

Browse files
lholmquistBridgeAR
authored andcommitted
doc: add documentation deprecation for process._tickCallback
This change also supports --pending-deprecation for the new deprecation. PR-URL: #29781 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
1 parent 62370ef commit 014eb67

File tree

2 files changed

+31
-0
lines changed

2 files changed

+31
-0
lines changed

doc/api/deprecations.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2494,6 +2494,33 @@ Type: Runtime
24942494
Passing a callback to [`worker.terminate()`][] is deprecated. Use the returned
24952495
`Promise` instead, or a listener to the worker’s `'exit'` event.
24962496
2497+
<a id="DEP0133"></a>
2498+
### DEP0133: http connection
2499+
<!-- YAML
2500+
changes:
2501+
- version: REPLACEME
2502+
pr-url: https://github.com/nodejs/node/pull/29015
2503+
description: Documentation-only deprecation.
2504+
-->
2505+
2506+
Type: Documentation-only
2507+
2508+
Prefer [`response.socket`][] over [`response.connection`] and
2509+
[`request.socket`][] over [`request.connection`].
2510+
2511+
<a id="DEP0XXX"></a>
2512+
### DEP0XXX: process._tickCallback
2513+
<!-- YAML
2514+
changes:
2515+
- version: REPLACEME
2516+
pr-url: https://github.com/nodejs/node/pull/29781
2517+
description: Documentation-only deprecation.
2518+
-->
2519+
Type: Documentation-only (supports [`--pending-deprecation`][])
2520+
2521+
The `process._tickCallback` property was never documented as
2522+
an officially supported API.
2523+
24972524
[`--http-parser=legacy`]: cli.html#cli_http_parser_library
24982525
[`--pending-deprecation`]: cli.html#cli_pending_deprecation
24992526
[`--throw-deprecation`]: cli.html#cli_throw_deprecation

lib/internal/bootstrap/pre_execution.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -271,6 +271,10 @@ function initializeDeprecations() {
271271
process.binding = deprecate(process.binding,
272272
'process.binding() is deprecated. ' +
273273
'Please use public APIs instead.', 'DEP0111');
274+
275+
process._tickCallback = deprecate(process._tickCallback,
276+
'process._tickCallback() is deprecated',
277+
'DEP0XXX');
274278
}
275279

276280
// Create global.process and global.Buffer as getters so that we have a

0 commit comments

Comments
 (0)