Skip to content

Commit 83418b5

Browse files
lholmquistTrott
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 420d4e4 commit 83418b5

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

doc/api/deprecations.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2519,6 +2519,19 @@ Type: Documentation-only
25192519
Prefer [`response.socket`][] over [`response.connection`] and
25202520
[`request.socket`][] over [`request.connection`].
25212521
2522+
<a id="DEP0XXX"></a>
2523+
### DEP0XXX: process._tickCallback
2524+
<!-- YAML
2525+
changes:
2526+
- version: REPLACEME
2527+
pr-url: https://github.com/nodejs/node/pull/29781
2528+
description: Documentation-only deprecation.
2529+
-->
2530+
Type: Documentation-only (supports [`--pending-deprecation`][])
2531+
2532+
The `process._tickCallback` property was never documented as
2533+
an officially supported API.
2534+
25222535
[`--pending-deprecation`]: cli.html#cli_pending_deprecation
25232536
[`--throw-deprecation`]: cli.html#cli_throw_deprecation
25242537
[`Buffer.allocUnsafeSlow(size)`]: buffer.html#buffer_class_method_buffer_allocunsafeslow_size

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)