doc: add MDN links for explicit resource management in fs #59557
+24
−4
Conversation
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
nodejs-github-bot
added
doc
Renegade334
reviewed
Aug 20, 2025
doc/api/fs.md
Outdated
| @@ -874,6 +874,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][]. | |||
There was a problem hiding this comment.
Suggested change
| see the [MDN documentation on `using` statements][]. | |
| see the [MDN documentation on `using` statements][`using`]. |
etc. to deduplicate the reference.
doc/api/fs.md
Outdated
| @@ -1342,10 +1346,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 using`][] as in | |||
There was a problem hiding this comment.
The point of this comment was to signpost the fact that an initialisation requires both await and await using; the intent is lost with this removal.
There was a problem hiding this comment.
I see your point, this syntax can be weird. I will update it to the previous comment but with a link. So it is easier to understand and we still get the link to the docs.
Renegade334
reviewed
Aug 20, 2025
doc/api/fs.md
Outdated
| @@ -1342,10 +1346,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 | |||
There was a problem hiding this comment.
Suggested change
| async, so it should be used with `await` + [`await using`] as in | |
| async, so it should be used with `await` + [`await using`][] as in |
Add cross-references to MDN documentation for `using` and `await using` statements in the fs module documentation. Remove TODO comment waiting for MDN documentation availability. Fixes: nodejs#59556
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add cross-references to MDN documentation for
usingandawait usingstatements in the fs module documentation.Remove TODO comment waiting for MDN documentation availability.
Fixes: #59556