Skip to content

doc: graduate Symbol.dispose/asyncDispose from experimental #58467

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

Closed
wants to merge 2 commits into from
Closed

doc: graduate Symbol.dispose/asyncDispose from experimental #58467

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cd8078e
doc: graduate Symbol.dispose/asyncDispose from experimental
jasnell May 26, 2025
9ea5449
Apply suggestions from code review
jasnell May 26, 2025
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
6 changes: 4 additions & 2 deletions doc/api/child_process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1764,10 +1764,12 @@
added:
- v20.5.0
- v18.18.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/00000

Check warning on line 1769 in doc/api/child_process.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 experimental.
-->

> Stability: 1 - Experimental

Calls [`subprocess.kill()`][] with `'SIGTERM'`.

### `subprocess.killed`
Expand Down
6 changes: 4 additions & 2 deletions doc/api/dgram.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -380,10 +380,12 @@
added:
- v20.5.0
- v18.18.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/00000

Check warning on line 385 in doc/api/dgram.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 experimental.
-->

> Stability: 1 - Experimental

Calls [`socket.close()`][] and returns a promise that fulfills when the
socket has closed.

Expand Down
20 changes: 13 additions & 7 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -859,10 +859,12 @@
added:
- v20.4.0
- v18.18.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/00000

Check warning on line 864 in doc/api/fs.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 experimental.
-->

> Stability: 1 - Experimental

Calls `filehandle.close()` and returns a promise that fulfills when the
filehandle is closed.

Expand Down Expand Up @@ -6754,21 +6756,25 @@

<!-- YAML
added: v24.1.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/00000

Check warning on line 6761 in doc/api/fs.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 experimental.
-->

> Stability: 1 - Experimental

Calls `dir.close()` and returns a promise that fulfills when the
dir is closed.

#### `dir[Symbol.Dispose]()`
#### `dir[Symbol.dispose]()`

<!-- YAML
added: v24.1.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/00000

Check warning on line 6774 in doc/api/fs.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 experimental.
-->

> Stability: 1 - Experimental

Calls `dir.closeSync()` and returns `undefined`.

### Class: `fs.Dirent`
Expand Down
6 changes: 4 additions & 2 deletions doc/api/http.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1936,10 +1936,12 @@

<!-- YAML
added: v20.4.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/00000

Check warning on line 1941 in doc/api/http.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 experimental.
-->

> Stability: 1 - Experimental

Calls [`server.close()`][] and returns a promise that fulfills when the
server has closed.

Expand Down
6 changes: 4 additions & 2 deletions doc/api/http2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2421,10 +2421,12 @@

<!-- YAML
added: v20.4.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/00000

Check warning on line 2426 in doc/api/http2.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 experimental.
-->

> Stability: 1 - Experimental

Calls [`server.close()`][] and returns a promise that fulfills when the
server has closed.

Expand Down
6 changes: 4 additions & 2 deletions doc/api/https.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,10 +137,12 @@

<!-- YAML
added: v20.4.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/00000

Check warning on line 142 in doc/api/https.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 experimental.
-->

> Stability: 1 - Experimental

Calls [`server.close()`][httpsServerClose] and returns a promise that
fulfills when the server has closed.

Expand Down
6 changes: 4 additions & 2 deletions doc/api/net.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -402,10 +402,12 @@
added:
- v20.5.0
- v18.18.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/00000

Check warning on line 407 in doc/api/net.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 experimental.
-->

> Stability: 1 - Experimental

Calls [`server.close()`][] and returns a promise that fulfills when the
server has closed.

Expand Down
6 changes: 4 additions & 2 deletions doc/api/sqlite.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -424,10 +424,12 @@
added:
- v23.11.0
- v22.15.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/00000

Check warning on line 429 in doc/api/sqlite.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 experimental.
-->

> Stability: 1 - Experimental

Closes the database connection. If the database connection is already closed
then this is a no-op.

Expand Down
12 changes: 8 additions & 4 deletions doc/api/stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -983,10 +983,12 @@ Getter for the property `objectMode` of a given `Writable` stream.
added:
- v22.4.0
- v20.16.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/00000
description: No longer experimental.
-->

> Stability: 1 - Experimental

Calls [`writable.destroy()`][writable-destroy] with an `AbortError` and returns
a promise that fulfills when the stream is finished.

Expand Down Expand Up @@ -1996,10 +1998,12 @@ has less then 64 KiB of data because no `highWaterMark` option is provided to
added:
- v20.4.0
- v18.18.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/00000
description: No longer experimental.
-->

> Stability: 1 - Experimental

Calls [`readable.destroy()`][readable-destroy] with an `AbortError` and returns
a promise that fulfills when the stream is finished.

Expand Down
12 changes: 8 additions & 4 deletions doc/api/timers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,10 +69,12 @@ invoked. Calling `immediate.unref()` multiple times will have no effect.
added:
- v20.5.0
- v18.18.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/00000
description: No longer experimental.
-->

> Stability: 1 - Experimental

Cancels the immediate. This is similar to calling `clearImmediate()`.

## Class: `Timeout`
Expand Down Expand Up @@ -175,10 +177,12 @@ thread. This allows enhanced compatibility with browser
added:
- v20.5.0
- v18.18.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/00000
description: No longer experimental.
-->

> Stability: 1 - Experimental

Cancels the timeout.

## Scheduling timers
Expand Down
Loading