mirror of
https://github.com/nodejs/node.git
synced 2024-11-21 10:59:27 +00:00
timers: deprecate active() and _unrefActive()
Another nail in the coffin here, farewell ye ol C-style apis. These apis caused numerous other issues that required far too many safeguards. This gets us one step closer to not having to worry about those issues anymore. Refs: https://github.com/nodejs/node/pull/18066 Refs: https://github.com/nodejs/node/pull/20298 PR-URL: https://github.com/nodejs/node/pull/26760 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
This commit is contained in:
parent
afce912193
commit
7c80f18c41
@ -2368,6 +2368,38 @@ Type: Runtime
|
|||||||
|
|
||||||
The `_stream_wrap` module is deprecated.
|
The `_stream_wrap` module is deprecated.
|
||||||
|
|
||||||
|
<a id="DEP0126"></a>
|
||||||
|
### DEP0126: timers.active()
|
||||||
|
<!-- YAML
|
||||||
|
changes:
|
||||||
|
- version: REPLACEME
|
||||||
|
pr-url: https://github.com/nodejs/node/pull/26760
|
||||||
|
description: Runtime deprecation.
|
||||||
|
-->
|
||||||
|
|
||||||
|
Type: Runtime
|
||||||
|
|
||||||
|
The previously undocumented `timers.active()` is deprecated.
|
||||||
|
Please use the publicly documented [`timeout.refresh()`][] instead.
|
||||||
|
If re-referencing the timeout is necessary, [`timeout.ref()`][] can be used
|
||||||
|
with no performance impact since Node.js 10.
|
||||||
|
|
||||||
|
<a id="DEP0127"></a>
|
||||||
|
### DEP0127: timers._unrefActive()
|
||||||
|
<!-- YAML
|
||||||
|
changes:
|
||||||
|
- version: REPLACEME
|
||||||
|
pr-url: https://github.com/nodejs/node/pull/26760
|
||||||
|
description: Runtime deprecation.
|
||||||
|
-->
|
||||||
|
|
||||||
|
Type: Runtime
|
||||||
|
|
||||||
|
The previously undocumented and "private" `timers._unrefActive()` is deprecated.
|
||||||
|
Please use the publicly documented [`timeout.refresh()`][] instead.
|
||||||
|
If unreferencing the timeout is necessary, [`timeout.unref()`][] can be used
|
||||||
|
with no performance impact since Node.js 10.
|
||||||
|
|
||||||
[`--pending-deprecation`]: cli.html#cli_pending_deprecation
|
[`--pending-deprecation`]: cli.html#cli_pending_deprecation
|
||||||
[`Buffer.allocUnsafeSlow(size)`]: buffer.html#buffer_class_method_buffer_allocunsafeslow_size
|
[`Buffer.allocUnsafeSlow(size)`]: buffer.html#buffer_class_method_buffer_allocunsafeslow_size
|
||||||
[`Buffer.from(array)`]: buffer.html#buffer_class_method_buffer_from_array
|
[`Buffer.from(array)`]: buffer.html#buffer_class_method_buffer_from_array
|
||||||
@ -2423,6 +2455,9 @@ The `_stream_wrap` module is deprecated.
|
|||||||
[`script.createCachedData()`]: vm.html#vm_script_createcacheddata
|
[`script.createCachedData()`]: vm.html#vm_script_createcacheddata
|
||||||
[`setInterval()`]: timers.html#timers_setinterval_callback_delay_args
|
[`setInterval()`]: timers.html#timers_setinterval_callback_delay_args
|
||||||
[`setTimeout()`]: timers.html#timers_settimeout_callback_delay_args
|
[`setTimeout()`]: timers.html#timers_settimeout_callback_delay_args
|
||||||
|
[`timeout.ref()`]: timers.html#timers_timeout_ref
|
||||||
|
[`timeout.refresh()`]: timers.html#timers_timeout_refresh
|
||||||
|
[`timeout.unref()`]: timers.html#timers_timeout_unref
|
||||||
[`tls.CryptoStream`]: tls.html#tls_class_cryptostream
|
[`tls.CryptoStream`]: tls.html#tls_class_cryptostream
|
||||||
[`tls.SecureContext`]: tls.html#tls_tls_createsecurecontext_options
|
[`tls.SecureContext`]: tls.html#tls_tls_createsecurecontext_options
|
||||||
[`tls.SecurePair`]: tls.html#tls_class_securepair
|
[`tls.SecurePair`]: tls.html#tls_class_securepair
|
||||||
|
@ -304,14 +304,21 @@ function clearImmediate(immediate) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
module.exports = {
|
module.exports = {
|
||||||
_unrefActive: unrefActive,
|
|
||||||
active,
|
|
||||||
setTimeout,
|
setTimeout,
|
||||||
clearTimeout,
|
clearTimeout,
|
||||||
setImmediate,
|
setImmediate,
|
||||||
clearImmediate,
|
clearImmediate,
|
||||||
setInterval,
|
setInterval,
|
||||||
clearInterval,
|
clearInterval,
|
||||||
|
_unrefActive: deprecate(
|
||||||
|
unrefActive,
|
||||||
|
'timers._unrefActive() is deprecated.' +
|
||||||
|
' Please use timeout.refresh() instead.',
|
||||||
|
'DEP0127'),
|
||||||
|
active: deprecate(
|
||||||
|
active,
|
||||||
|
'timers.active() is deprecated. Please use timeout.refresh() instead.',
|
||||||
|
'DEP0126'),
|
||||||
unenroll: deprecate(
|
unenroll: deprecate(
|
||||||
unenroll,
|
unenroll,
|
||||||
'timers.unenroll() is deprecated. Please use clearTimeout instead.',
|
'timers.unenroll() is deprecated. Please use clearTimeout instead.',
|
||||||
|
@ -19,7 +19,7 @@ process.on('warning', common.mustCall((warning) => {
|
|||||||
assert.strictEqual(lines[0], `${OVERFLOW} does not fit into a 32-bit signed` +
|
assert.strictEqual(lines[0], `${OVERFLOW} does not fit into a 32-bit signed` +
|
||||||
' integer.');
|
' integer.');
|
||||||
assert.strictEqual(lines.length, 2);
|
assert.strictEqual(lines.length, 2);
|
||||||
}, 5));
|
}, 6));
|
||||||
|
|
||||||
|
|
||||||
{
|
{
|
||||||
|
Loading…
Reference in New Issue
Block a user