timers: runtime-deprecate Timeout.prototype[Symbol.dispose] - #64615
Open
mcollina wants to merge 2 commits into
Open
timers: runtime-deprecate Timeout.prototype[Symbol.dispose]#64615mcollina wants to merge 2 commits into
mcollina wants to merge 2 commits into
Conversation
Collaborator
|
Review requested:
|
nodejs-github-bot
added
needs-ci
mcollina
force-pushed
the
fix/dep0208-timeout-symbol-dispose
branch
from
July 20, 2026 08:27
f139ee5 to
669757d
Compare
Emit a DEP0208 deprecation warning when Timeout.prototype[Symbol.dispose] is called. The web platform setTimeout()/setInterval() APIs return a number, which cannot implement Symbol.dispose. Prefer clearTimeout() instead. Immediate.prototype[Symbol.dispose] is left unchanged. Fixes: nodejs#58689 Signed-off-by: Matteo Collina <hello@matteocollina.com>
mcollina
force-pushed
the
fix/dep0208-timeout-symbol-dispose
branch
from
July 20, 2026 08:49
669757d to
c6558b0
Compare
| [`setTimeout()`][] and [`setInterval()`][] APIs return a number, which cannot | ||
| implement `Symbol.dispose`. Prefer [`clearTimeout()`][] instead to cancel a | ||
| timeout. This deprecation does not apply to [`Immediate`][] objects returned by | ||
| [`setImmediate()`][]. |
Member
There was a problem hiding this comment.
since this deprecation have clear before after change could you add code snippets to that.
islandryu
approved these changes
Jul 20, 2026
Add code examples showing migration from Timeout.prototype[Symbol.dispose] to clearTimeout(). Refs: nodejs#64615 Signed-off-by: Matteo Collina <hello@matteocollina.com>
Member
Author
|
Added before/after code snippets to DEP0208 as requested. |
Member
Web or not, I'd add a +1 for deprecating this as well for consistency, are there any real uses for disposing of an Immediate in the same block as it was created? https://github.com/search?q=language%3AJavaScript+%2Fusing+%5CS%2B+%3D+setImmediate%2F&type=code |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #64615 +/- ##
==========================================
- Coverage 90.24% 90.14% -0.11%
==========================================
Files 739 741 +2
Lines 241772 242077 +305
Branches 45561 45541 -20
==========================================
+ Hits 218194 218211 +17
- Misses 15111 15362 +251
- Partials 8467 8504 +37
🚀 New features to boost your workflow:
|
AugustinMauroy
approved these changes
Jul 20, 2026
AugustinMauroy
left a comment
AugustinMauroy
left a comment
Member
There was a problem hiding this comment.
in term of docs it's super nice.
and in terms of the deprecation LGTM
avivkeller
added
the
semver-major
avivkeller
approved these changes
Jul 24, 2026
mcollina
added
request-ci
github-actions
Bot
removed
the
request-ci
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
Collaborator
This was referenced Jul 26, 2026
legendecas
approved these changes
Aug 5, 2026
RafaelGSS
approved these changes
Aug 5, 2026
aduh95
approved these changes
Aug 5, 2026
aduh95
left a comment
aduh95
left a comment
Contributor
There was a problem hiding this comment.
I would be interested to see this API back in a web-compat way, but in the mean time deprecating makes sense
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
9 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Emit a DEP0208 runtime deprecation warning when
Timeout.prototype[Symbol.dispose]is called.The web platform
setTimeout()/setInterval()APIs return a number,which cannot implement
Symbol.dispose. Leaving this integration in placeencourages code that is incompatible between Node.js and browsers (and
other server-side platforms that follow the web timers API).
Immediate.prototype[Symbol.dispose]is intentionally left unchanged,since
setImmediateis not a web platform API.Prefer
clearTimeout()to cancel a timeout.Fixes: #58689