Skip to content

doc: add MDN links for explicit resource management in fs #59557

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
Renegade334 merged 1 commit into from
Jul 28, 2026
Merged

doc: add MDN links for explicit resource management in fs #59557

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
28 changes: 24 additions & 4 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1188,6 +1188,10 @@ changes:
Calls `filehandle.close()` and returns a promise that fulfills when the
filehandle is closed.

This method enables the filehandle to be used with [`await using`][], which
will automatically close the file when the scope exits. For more information,
see the [MDN documentation on `using` statements][`using`].

### `fsPromises.access(path[, mode])`

<!-- YAML
Expand Down Expand Up @@ -1672,10 +1676,11 @@ directory cannot be deleted, disposal will throw an error. The object has an
async `remove()` method which will perform the same task.

Both this function and the disposal function on the resulting object are
async, so it should be used with `await` + `await using` as in
async, so it should be used with `await` + [`await using`][] as in
`await using dir = await fsPromises.mkdtempDisposable('prefix')`.

<!-- TODO: link MDN docs for disposables once https://github.com/mdn/content/pull/38027 lands -->
See the [MDN documentation on `using` statements][`using`] for more information about
explicit resource management.

For detailed information, see the documentation of [`fsPromises.mkdtemp()`][].

Expand Down Expand Up @@ -6430,12 +6435,13 @@ removed if it still exists. If the directory cannot be deleted, disposal will
throw an error. The object has a `remove()` method which will perform the same
task.

<!-- TODO: link MDN docs for disposables once https://github.com/mdn/content/pull/38027 lands -->
See the [MDN documentation on `using` statements][`using`] for more information about
explicit resource management.

For detailed information, see the documentation of [`fs.mkdtemp()`][].

There is no callback-based version of this API because it is designed for use
with the `using` syntax.
with the [`using`][] syntax.

The optional `options` argument can be a string specifying an encoding, or an
object with an `encoding` property specifying the character encoding to use.
Expand Down Expand Up @@ -7307,6 +7313,10 @@ changes:
Calls `dir.close()` if the directory handle is open, and returns a promise that
fulfills when disposal is complete.

This method enables the directory to be used with [`await using`][], which
will automatically close the directory when the scope exits. For more
information, see the [MDN documentation on `using` statements][`using`].

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

<!-- YAML
Expand All @@ -7322,6 +7332,10 @@ changes:
Calls `dir.closeSync()` if the directory handle is open, and returns
`undefined`.

This method enables the directory to be used with [`using`][], which
will automatically close the directory when the scope exits. For more
information, see the [MDN documentation on `using` statements][`using`].

### Class: `fs.Dirent`

<!-- YAML
Expand Down Expand Up @@ -8458,6 +8472,10 @@ the `data` argument must be a {Buffer}.

Calls `utf8Stream.destroy()`.

This method enables the stream to be used with [`using`][], which
will automatically destroy the stream when the scope exits. For more
information, see the [MDN documentation on `using` statements][`using`].

### Class: `fs.WriteStream`

<!-- YAML
Expand Down Expand Up @@ -9274,6 +9292,7 @@ the file contents.
[`Number.MAX_SAFE_INTEGER`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER
[`ReadDirectoryChangesW`]: https://docs.microsoft.com/en-us/windows/desktop/api/winbase/nf-winbase-readdirectorychangesw
[`UV_THREADPOOL_SIZE`]: cli.md#uv_threadpool_sizesize
[`await using`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/await_using
[`event ports`]: https://illumos.org/man/port_create
[`filehandle.createReadStream()`]: #filehandlecreatereadstreamoptions
[`filehandle.createWriteStream()`]: #filehandlecreatewritestreamoptions
Expand Down Expand Up @@ -9333,6 +9352,7 @@ the file contents.
[`stream/iter pipeTo()`]: stream_iter.md#pipetosource-transforms-writer-options
[`stream/iter pull()`]: stream_iter.md#pullsource-transforms-options
[`stream/iter pullSync()`]: stream_iter.md#pullsyncsource-transforms
[`using`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/using
[`util.promisify()`]: util.md#utilpromisifyoriginal
[bigints]: https://tc39.github.io/proposal-bigint
[caveats]: #caveats
Expand Down
Loading