Skip to content

doc: domain.add() does not accept timer objects #60675

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nodejs-github-bot merged 1 commit into from
Nov 13, 2025
+12 −12
Merged

doc: domain.add() does not accept timer objects #60675

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions doc/api/domain.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,24 +289,26 @@

* Type: {Array}

An array of timers and event emitters that have been explicitly added
to the domain.
An array of event emitters that have been explicitly added to the domain.

### `domain.add(emitter)`

* `emitter` {EventEmitter|Timer} emitter or timer to be added to the domain
<!-- YAML
changes:
- version: v9.3.0
pr-url: https://github.com/nodejs/node/pull/16222

Check warning on line 299 in doc/api/domain.md

View workflow job for this annotation

GitHub Actions / lint-pr-url 

pr-url doesn't match the URL of the current PR.
description: No longer accepts timer objects.
-->

* `emitter` {EventEmitter} emitter to be added to the domain

Explicitly adds an emitter to the domain. If any event handlers called by
the emitter throw an error, or if the emitter emits an `'error'` event, it
will be routed to the domain's `'error'` event, just like with implicit
binding.

This also works with timers that are returned from [`setInterval()`][] and
[`setTimeout()`][]. If their callback function throws, it will be caught by
the domain `'error'` handler.

If the Timer or `EventEmitter` was already bound to a domain, it is removed
from that one, and bound to this one instead.
If the `EventEmitter` was already bound to a domain, it is removed from that
one, and bound to this one instead.

### `domain.bind(callback)`

Expand Down Expand Up @@ -398,7 +400,7 @@

### `domain.remove(emitter)`

* `emitter` {EventEmitter|Timer} emitter or timer to be removed from the domain
* `emitter` {EventEmitter} emitter to be removed from the domain

The opposite of [`domain.add(emitter)`][]. Removes domain handling from the
specified emitter.
Expand Down Expand Up @@ -484,6 +486,4 @@
[`domain.add(emitter)`]: #domainaddemitter
[`domain.bind(callback)`]: #domainbindcallback
[`domain.exit()`]: #domainexit
[`setInterval()`]: timers.md#setintervalcallback-delay-args
[`setTimeout()`]: timers.md#settimeoutcallback-delay-args
[`throw`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/throw
Loading