Commit 2de1d76

Browse files
lluisemperaduh95
authored andcommitted
doc: add MDN links for explicit resource management in fs
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: #59556 PR-URL: #59557 Reviewed-By: RenΓ© <contact.9a5d6388@renegade334.me.uk>
1 parent 9209cc4 commit 2de1d76

1 file changed

Lines changed: 24 additions & 4 deletions

File tree

β€Ždoc/api/fs.mdβ€Ž

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1183,6 +1183,10 @@ changes:
11831183
Calls `filehandle.close()` and returns a promise that fulfills when the
11841184
filehandle is closed.
11851185
1186+
This method enables the filehandle to be used with [`await using`][], which
1187+
will automatically close the file when the scope exits. For more information,
1188+
see the [MDN documentation on `using` statements][`using`].
1189+
11861190
### `fsPromises.access(path[, mode])`
11871191
11881192
<!-- YAML
@@ -1661,10 +1665,11 @@ directory cannot be deleted, disposal will throw an error. The object has an
16611665
async `remove()` method which will perform the same task.
16621666
16631667
Both this function and the disposal function on the resulting object are
1664-
async, so it should be used with `await` + `await using` as in
1668+
async, so it should be used with `await` + [`await using`][] as in
16651669
`await using dir =awaitfsPromises.mkdtempDisposable('prefix')`.
16661670
1667-
<!-- TODO: link MDN docs for disposables once https://github.com/mdn/content/pull/38027 lands -->
1671+
See the [MDN documentation on `using` statements][`using`] for more information about
1672+
explicit resource management.
16681673
16691674
For detailed information, see the documentation of [`fsPromises.mkdtemp()`][].
16701675
@@ -6393,12 +6398,13 @@ removed if it still exists. If the directory cannot be deleted, disposal will
63936398
throw an error. The object has a `remove()` method which will perform the same
63946399
task.
63956400
6396-
<!-- TODO: link MDN docs for disposables once https://github.com/mdn/content/pull/38027 lands -->
6401+
See the [MDN documentation on `using` statements][`using`] for more information about
6402+
explicit resource management.
63976403
63986404
For detailed information, see the documentation of [`fs.mkdtemp()`][].
63996405
64006406
There is no callback-based version of this API because it is designed for use
6401-
with the `using` syntax.
6407+
with the [`using`][] syntax.
64026408
64036409
The optional `options` argument can be a string specifying an encoding, or an
64046410
object with an `encoding` property specifying the character encoding to use.
@@ -7273,6 +7279,10 @@ changes:
72737279
Calls `dir.close()` if the directory handle is open, and returns a promise that
72747280
fulfills when disposal is complete.
72757281
7282+
This method enables the directory to be used with [`await using`][], which
7283+
will automatically close the directory when the scope exits. For more
7284+
information, see the [MDN documentation on `using` statements][`using`].
7285+
72767286
#### `dir[Symbol.dispose]()`
72777287
72787288
<!-- YAML
@@ -7286,6 +7296,10 @@ changes:
72867296
Calls `dir.closeSync()` if the directory handle is open, and returns
72877297
`undefined`.
72887298
7299+
This method enables the directory to be used with [`using`][], which
7300+
will automatically close the directory when the scope exits. For more
7301+
information, see the [MDN documentation on `using` statements][`using`].
7302+
72897303
### Class: `fs.Dirent`
72907304
72917305
<!-- YAML
@@ -8397,6 +8411,10 @@ the `data` argument must be a {Buffer}.
83978411
83988412
Calls `utf8Stream.destroy()`.
83998413
8414+
This method enables the stream to be used with [`using`][], which
8415+
will automatically destroy the stream when the scope exits. For more
8416+
information, see the [MDN documentation on `using` statements][`using`].
8417+
84008418
### Class: `fs.WriteStream`
84018419
84028420
<!-- YAML
@@ -9213,6 +9231,7 @@ the file contents.
92139231
[`Number.MAX_SAFE_INTEGER`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER
92149232
[`ReadDirectoryChangesW`]: https://docs.microsoft.com/en-us/windows/desktop/api/winbase/nf-winbase-readdirectorychangesw
92159233
[`UV_THREADPOOL_SIZE`]: cli.md#uv_threadpool_sizesize
9234+
[`await using`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/await_using
92169235
[`event ports`]: https://illumos.org/man/port_create
92179236
[`filehandle.createReadStream()`]: #filehandlecreatereadstreamoptions
92189237
[`filehandle.createWriteStream()`]: #filehandlecreatewritestreamoptions
@@ -9272,6 +9291,7 @@ the file contents.
92729291
[`stream/iter pipeTo()`]: stream_iter.md#pipetosource-transforms-writer-options
92739292
[`stream/iter pull()`]: stream_iter.md#pullsource-transforms-options
92749293
[`stream/iter pullSync()`]: stream_iter.md#pullsyncsource-transforms
9294+
[`using`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/using
92759295
[`util.promisify()`]: util.md#utilpromisifyoriginal
92769296
[bigints]: https://tc39.github.io/proposal-bigint
92779297
[caveats]: #caveats

0 commit comments

Comments
Β (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Commit 2de1d76

Browse files
lluisemperaduh95
authored andcommitted
doc: add MDN links for explicit resource management in fs
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: #59556 PR-URL: #59557 Reviewed-By: RenΓ© <contact.9a5d6388@renegade334.me.uk>
1 parent 9209cc4 commit 2de1d76

1 file changed

Lines changed: 24 additions & 4 deletions

File tree

β€Ždoc/api/fs.mdβ€Ž

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1183,6 +1183,10 @@ changes:
11831183
Calls `filehandle.close()` and returns a promise that fulfills when the
11841184
filehandle is closed.
11851185
1186+
This method enables the filehandle to be used with [`await using`][], which
1187+
will automatically close the file when the scope exits. For more information,
1188+
see the [MDN documentation on `using` statements][`using`].
1189+
11861190
### `fsPromises.access(path[, mode])`
11871191
11881192
<!-- YAML
@@ -1661,10 +1665,11 @@ directory cannot be deleted, disposal will throw an error. The object has an
16611665
async `remove()` method which will perform the same task.
16621666
16631667
Both this function and the disposal function on the resulting object are
1664-
async, so it should be used with `await` + `await using` as in
1668+
async, so it should be used with `await` + [`await using`][] as in
16651669
`await using dir =awaitfsPromises.mkdtempDisposable('prefix')`.
16661670
1667-
<!-- TODO: link MDN docs for disposables once https://github.com/mdn/content/pull/38027 lands -->
1671+
See the [MDN documentation on `using` statements][`using`] for more information about
1672+
explicit resource management.
16681673
16691674
For detailed information, see the documentation of [`fsPromises.mkdtemp()`][].
16701675
@@ -6393,12 +6398,13 @@ removed if it still exists. If the directory cannot be deleted, disposal will
63936398
throw an error. The object has a `remove()` method which will perform the same
63946399
task.
63956400
6396-
<!-- TODO: link MDN docs for disposables once https://github.com/mdn/content/pull/38027 lands -->
6401+
See the [MDN documentation on `using` statements][`using`] for more information about
6402+
explicit resource management.
63976403
63986404
For detailed information, see the documentation of [`fs.mkdtemp()`][].
63996405
64006406
There is no callback-based version of this API because it is designed for use
6401-
with the `using` syntax.
6407+
with the [`using`][] syntax.
64026408
64036409
The optional `options` argument can be a string specifying an encoding, or an
64046410
object with an `encoding` property specifying the character encoding to use.
@@ -7273,6 +7279,10 @@ changes:
72737279
Calls `dir.close()` if the directory handle is open, and returns a promise that
72747280
fulfills when disposal is complete.
72757281
7282+
This method enables the directory to be used with [`await using`][], which
7283+
will automatically close the directory when the scope exits. For more
7284+
information, see the [MDN documentation on `using` statements][`using`].
7285+
72767286
#### `dir[Symbol.dispose]()`
72777287
72787288
<!-- YAML
@@ -7286,6 +7296,10 @@ changes:
72867296
Calls `dir.closeSync()` if the directory handle is open, and returns
72877297
`undefined`.
72887298
7299+
This method enables the directory to be used with [`using`][], which
7300+
will automatically close the directory when the scope exits. For more
7301+
information, see the [MDN documentation on `using` statements][`using`].
7302+
72897303
### Class: `fs.Dirent`
72907304
72917305
<!-- YAML
@@ -8397,6 +8411,10 @@ the `data` argument must be a {Buffer}.
83978411
83988412
Calls `utf8Stream.destroy()`.
83998413
8414+
This method enables the stream to be used with [`using`][], which
8415+
will automatically destroy the stream when the scope exits. For more
8416+
information, see the [MDN documentation on `using` statements][`using`].
8417+
84008418
### Class: `fs.WriteStream`
84018419
84028420
<!-- YAML
@@ -9213,6 +9231,7 @@ the file contents.
92139231
[`Number.MAX_SAFE_INTEGER`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER
92149232
[`ReadDirectoryChangesW`]: https://docs.microsoft.com/en-us/windows/desktop/api/winbase/nf-winbase-readdirectorychangesw
92159233
[`UV_THREADPOOL_SIZE`]: cli.md#uv_threadpool_sizesize
9234+
[`await using`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/await_using
92169235
[`event ports`]: https://illumos.org/man/port_create
92179236
[`filehandle.createReadStream()`]: #filehandlecreatereadstreamoptions
92189237
[`filehandle.createWriteStream()`]: #filehandlecreatewritestreamoptions
@@ -9272,6 +9291,7 @@ the file contents.
92729291
[`stream/iter pipeTo()`]: stream_iter.md#pipetosource-transforms-writer-options
92739292
[`stream/iter pull()`]: stream_iter.md#pullsource-transforms-options
92749293
[`stream/iter pullSync()`]: stream_iter.md#pullsyncsource-transforms
9294+
[`using`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/using
92759295
[`util.promisify()`]: util.md#utilpromisifyoriginal
92769296
[bigints]: https://tc39.github.io/proposal-bigint
92779297
[caveats]: #caveats

0 commit comments

Comments
Β (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Commit 2de1d76

Browse files
lluisemperaduh95
authored andcommitted
doc: add MDN links for explicit resource management in fs
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: #59556 PR-URL: #59557 Reviewed-By: RenΓ© <contact.9a5d6388@renegade334.me.uk>
1 parent 9209cc4 commit 2de1d76

1 file changed

Lines changed: 24 additions & 4 deletions

File tree

β€Ždoc/api/fs.mdβ€Ž

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1183,6 +1183,10 @@ changes:
11831183
Calls `filehandle.close()` and returns a promise that fulfills when the
11841184
filehandle is closed.
11851185
1186+
This method enables the filehandle to be used with [`await using`][], which
1187+
will automatically close the file when the scope exits. For more information,
1188+
see the [MDN documentation on `using` statements][`using`].
1189+
11861190
### `fsPromises.access(path[, mode])`
11871191
11881192
<!-- YAML
@@ -1661,10 +1665,11 @@ directory cannot be deleted, disposal will throw an error. The object has an
16611665
async `remove()` method which will perform the same task.
16621666
16631667
Both this function and the disposal function on the resulting object are
1664-
async, so it should be used with `await` + `await using` as in
1668+
async, so it should be used with `await` + [`await using`][] as in
16651669
`await using dir =awaitfsPromises.mkdtempDisposable('prefix')`.
16661670
1667-
<!-- TODO: link MDN docs for disposables once https://github.com/mdn/content/pull/38027 lands -->
1671+
See the [MDN documentation on `using` statements][`using`] for more information about
1672+
explicit resource management.
16681673
16691674
For detailed information, see the documentation of [`fsPromises.mkdtemp()`][].
16701675
@@ -6393,12 +6398,13 @@ removed if it still exists. If the directory cannot be deleted, disposal will
63936398
throw an error. The object has a `remove()` method which will perform the same
63946399
task.
63956400
6396-
<!-- TODO: link MDN docs for disposables once https://github.com/mdn/content/pull/38027 lands -->
6401+
See the [MDN documentation on `using` statements][`using`] for more information about
6402+
explicit resource management.
63976403
63986404
For detailed information, see the documentation of [`fs.mkdtemp()`][].
63996405
64006406
There is no callback-based version of this API because it is designed for use
6401-
with the `using` syntax.
6407+
with the [`using`][] syntax.
64026408
64036409
The optional `options` argument can be a string specifying an encoding, or an
64046410
object with an `encoding` property specifying the character encoding to use.
@@ -7273,6 +7279,10 @@ changes:
72737279
Calls `dir.close()` if the directory handle is open, and returns a promise that
72747280
fulfills when disposal is complete.
72757281
7282+
This method enables the directory to be used with [`await using`][], which
7283+
will automatically close the directory when the scope exits. For more
7284+
information, see the [MDN documentation on `using` statements][`using`].
7285+
72767286
#### `dir[Symbol.dispose]()`
72777287
72787288
<!-- YAML
@@ -7286,6 +7296,10 @@ changes:
72867296
Calls `dir.closeSync()` if the directory handle is open, and returns
72877297
`undefined`.
72887298
7299+
This method enables the directory to be used with [`using`][], which
7300+
will automatically close the directory when the scope exits. For more
7301+
information, see the [MDN documentation on `using` statements][`using`].
7302+
72897303
### Class: `fs.Dirent`
72907304
72917305
<!-- YAML
@@ -8397,6 +8411,10 @@ the `data` argument must be a {Buffer}.
83978411
83988412
Calls `utf8Stream.destroy()`.
83998413
8414+
This method enables the stream to be used with [`using`][], which
8415+
will automatically destroy the stream when the scope exits. For more
8416+
information, see the [MDN documentation on `using` statements][`using`].
8417+
84008418
### Class: `fs.WriteStream`
84018419
84028420
<!-- YAML
@@ -9213,6 +9231,7 @@ the file contents.
92139231
[`Number.MAX_SAFE_INTEGER`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER
92149232
[`ReadDirectoryChangesW`]: https://docs.microsoft.com/en-us/windows/desktop/api/winbase/nf-winbase-readdirectorychangesw
92159233
[`UV_THREADPOOL_SIZE`]: cli.md#uv_threadpool_sizesize
9234+
[`await using`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/await_using
92169235
[`event ports`]: https://illumos.org/man/port_create
92179236
[`filehandle.createReadStream()`]: #filehandlecreatereadstreamoptions
92189237
[`filehandle.createWriteStream()`]: #filehandlecreatewritestreamoptions
@@ -9272,6 +9291,7 @@ the file contents.
92729291
[`stream/iter pipeTo()`]: stream_iter.md#pipetosource-transforms-writer-options
92739292
[`stream/iter pull()`]: stream_iter.md#pullsource-transforms-options
92749293
[`stream/iter pullSync()`]: stream_iter.md#pullsyncsource-transforms
9294+
[`using`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/using
92759295
[`util.promisify()`]: util.md#utilpromisifyoriginal
92769296
[bigints]: https://tc39.github.io/proposal-bigint
92779297
[caveats]: #caveats

0 commit comments

Comments
Β (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Commit 2de1d76

Browse files
lluisemperaduh95
authored andcommitted
doc: add MDN links for explicit resource management in fs
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: #59556 PR-URL: #59557 Reviewed-By: RenΓ© <contact.9a5d6388@renegade334.me.uk>
1 parent 9209cc4 commit 2de1d76

1 file changed

Lines changed: 24 additions & 4 deletions

File tree

β€Ždoc/api/fs.mdβ€Ž

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1183,6 +1183,10 @@ changes:
11831183
Calls `filehandle.close()` and returns a promise that fulfills when the
11841184
filehandle is closed.
11851185
1186+
This method enables the filehandle to be used with [`await using`][], which
1187+
will automatically close the file when the scope exits. For more information,
1188+
see the [MDN documentation on `using` statements][`using`].
1189+
11861190
### `fsPromises.access(path[, mode])`
11871191
11881192
<!-- YAML
@@ -1661,10 +1665,11 @@ directory cannot be deleted, disposal will throw an error. The object has an
16611665
async `remove()` method which will perform the same task.
16621666
16631667
Both this function and the disposal function on the resulting object are
1664-
async, so it should be used with `await` + `await using` as in
1668+
async, so it should be used with `await` + [`await using`][] as in
16651669
`await using dir =awaitfsPromises.mkdtempDisposable('prefix')`.
16661670
1667-
<!-- TODO: link MDN docs for disposables once https://github.com/mdn/content/pull/38027 lands -->
1671+
See the [MDN documentation on `using` statements][`using`] for more information about
1672+
explicit resource management.
16681673
16691674
For detailed information, see the documentation of [`fsPromises.mkdtemp()`][].
16701675
@@ -6393,12 +6398,13 @@ removed if it still exists. If the directory cannot be deleted, disposal will
63936398
throw an error. The object has a `remove()` method which will perform the same
63946399
task.
63956400
6396-
<!-- TODO: link MDN docs for disposables once https://github.com/mdn/content/pull/38027 lands -->
6401+
See the [MDN documentation on `using` statements][`using`] for more information about
6402+
explicit resource management.
63976403
63986404
For detailed information, see the documentation of [`fs.mkdtemp()`][].
63996405
64006406
There is no callback-based version of this API because it is designed for use
6401-
with the `using` syntax.
6407+
with the [`using`][] syntax.
64026408
64036409
The optional `options` argument can be a string specifying an encoding, or an
64046410
object with an `encoding` property specifying the character encoding to use.
@@ -7273,6 +7279,10 @@ changes:
72737279
Calls `dir.close()` if the directory handle is open, and returns a promise that
72747280
fulfills when disposal is complete.
72757281
7282+
This method enables the directory to be used with [`await using`][], which
7283+
will automatically close the directory when the scope exits. For more
7284+
information, see the [MDN documentation on `using` statements][`using`].
7285+
72767286
#### `dir[Symbol.dispose]()`
72777287
72787288
<!-- YAML
@@ -7286,6 +7296,10 @@ changes:
72867296
Calls `dir.closeSync()` if the directory handle is open, and returns
72877297
`undefined`.
72887298
7299+
This method enables the directory to be used with [`using`][], which
7300+
will automatically close the directory when the scope exits. For more
7301+
information, see the [MDN documentation on `using` statements][`using`].
7302+
72897303
### Class: `fs.Dirent`
72907304
72917305
<!-- YAML
@@ -8397,6 +8411,10 @@ the `data` argument must be a {Buffer}.
83978411
83988412
Calls `utf8Stream.destroy()`.
83998413
8414+
This method enables the stream to be used with [`using`][], which
8415+
will automatically destroy the stream when the scope exits. For more
8416+
information, see the [MDN documentation on `using` statements][`using`].
8417+
84008418
### Class: `fs.WriteStream`
84018419
84028420
<!-- YAML
@@ -9213,6 +9231,7 @@ the file contents.
92139231
[`Number.MAX_SAFE_INTEGER`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER
92149232
[`ReadDirectoryChangesW`]: https://docs.microsoft.com/en-us/windows/desktop/api/winbase/nf-winbase-readdirectorychangesw
92159233
[`UV_THREADPOOL_SIZE`]: cli.md#uv_threadpool_sizesize
9234+
[`await using`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/await_using
92169235
[`event ports`]: https://illumos.org/man/port_create
92179236
[`filehandle.createReadStream()`]: #filehandlecreatereadstreamoptions
92189237
[`filehandle.createWriteStream()`]: #filehandlecreatewritestreamoptions
@@ -9272,6 +9291,7 @@ the file contents.
92729291
[`stream/iter pipeTo()`]: stream_iter.md#pipetosource-transforms-writer-options
92739292
[`stream/iter pull()`]: stream_iter.md#pullsource-transforms-options
92749293
[`stream/iter pullSync()`]: stream_iter.md#pullsyncsource-transforms
9294+
[`using`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/using
92759295
[`util.promisify()`]: util.md#utilpromisifyoriginal
92769296
[bigints]: https://tc39.github.io/proposal-bigint
92779297
[caveats]: #caveats

0 commit comments

Comments
Β (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Commit 2de1d76

Browse files
lluisemperaduh95
authored andcommitted
doc: add MDN links for explicit resource management in fs
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: #59556 PR-URL: #59557 Reviewed-By: RenΓ© <contact.9a5d6388@renegade334.me.uk>
1 parent 9209cc4 commit 2de1d76

1 file changed

Lines changed: 24 additions & 4 deletions

File tree

β€Ždoc/api/fs.mdβ€Ž

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1183,6 +1183,10 @@ changes:
11831183
Calls `filehandle.close()` and returns a promise that fulfills when the
11841184
filehandle is closed.
11851185
1186+
This method enables the filehandle to be used with [`await using`][], which
1187+
will automatically close the file when the scope exits. For more information,
1188+
see the [MDN documentation on `using` statements][`using`].
1189+
11861190
### `fsPromises.access(path[, mode])`
11871191
11881192
<!-- YAML
@@ -1661,10 +1665,11 @@ directory cannot be deleted, disposal will throw an error. The object has an
16611665
async `remove()` method which will perform the same task.
16621666
16631667
Both this function and the disposal function on the resulting object are
1664-
async, so it should be used with `await` + `await using` as in
1668+
async, so it should be used with `await` + [`await using`][] as in
16651669
`await using dir =awaitfsPromises.mkdtempDisposable('prefix')`.
16661670
1667-
<!-- TODO: link MDN docs for disposables once https://github.com/mdn/content/pull/38027 lands -->
1671+
See the [MDN documentation on `using` statements][`using`] for more information about
1672+
explicit resource management.
16681673
16691674
For detailed information, see the documentation of [`fsPromises.mkdtemp()`][].
16701675
@@ -6393,12 +6398,13 @@ removed if it still exists. If the directory cannot be deleted, disposal will
63936398
throw an error. The object has a `remove()` method which will perform the same
63946399
task.
63956400
6396-
<!-- TODO: link MDN docs for disposables once https://github.com/mdn/content/pull/38027 lands -->
6401+
See the [MDN documentation on `using` statements][`using`] for more information about
6402+
explicit resource management.
63976403
63986404
For detailed information, see the documentation of [`fs.mkdtemp()`][].
63996405
64006406
There is no callback-based version of this API because it is designed for use
6401-
with the `using` syntax.
6407+
with the [`using`][] syntax.
64026408
64036409
The optional `options` argument can be a string specifying an encoding, or an
64046410
object with an `encoding` property specifying the character encoding to use.
@@ -7273,6 +7279,10 @@ changes:
72737279
Calls `dir.close()` if the directory handle is open, and returns a promise that
72747280
fulfills when disposal is complete.
72757281
7282+
This method enables the directory to be used with [`await using`][], which
7283+
will automatically close the directory when the scope exits. For more
7284+
information, see the [MDN documentation on `using` statements][`using`].
7285+
72767286
#### `dir[Symbol.dispose]()`
72777287
72787288
<!-- YAML
@@ -7286,6 +7296,10 @@ changes:
72867296
Calls `dir.closeSync()` if the directory handle is open, and returns
72877297
`undefined`.
72887298
7299+
This method enables the directory to be used with [`using`][], which
7300+
will automatically close the directory when the scope exits. For more
7301+
information, see the [MDN documentation on `using` statements][`using`].
7302+
72897303
### Class: `fs.Dirent`
72907304
72917305
<!-- YAML
@@ -8397,6 +8411,10 @@ the `data` argument must be a {Buffer}.
83978411
83988412
Calls `utf8Stream.destroy()`.
83998413
8414+
This method enables the stream to be used with [`using`][], which
8415+
will automatically destroy the stream when the scope exits. For more
8416+
information, see the [MDN documentation on `using` statements][`using`].
8417+
84008418
### Class: `fs.WriteStream`
84018419
84028420
<!-- YAML
@@ -9213,6 +9231,7 @@ the file contents.
92139231
[`Number.MAX_SAFE_INTEGER`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER
92149232
[`ReadDirectoryChangesW`]: https://docs.microsoft.com/en-us/windows/desktop/api/winbase/nf-winbase-readdirectorychangesw
92159233
[`UV_THREADPOOL_SIZE`]: cli.md#uv_threadpool_sizesize
9234+
[`await using`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/await_using
92169235
[`event ports`]: https://illumos.org/man/port_create
92179236
[`filehandle.createReadStream()`]: #filehandlecreatereadstreamoptions
92189237
[`filehandle.createWriteStream()`]: #filehandlecreatewritestreamoptions
@@ -9272,6 +9291,7 @@ the file contents.
92729291
[`stream/iter pipeTo()`]: stream_iter.md#pipetosource-transforms-writer-options
92739292
[`stream/iter pull()`]: stream_iter.md#pullsource-transforms-options
92749293
[`stream/iter pullSync()`]: stream_iter.md#pullsyncsource-transforms
9294+
[`using`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/using
92759295
[`util.promisify()`]: util.md#utilpromisifyoriginal
92769296
[bigints]: https://tc39.github.io/proposal-bigint
92779297
[caveats]: #caveats

0 commit comments

Comments
Β (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Commit 2de1d76

Browse files
lluisemperaduh95
authored andcommitted
doc: add MDN links for explicit resource management in fs
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: #59556 PR-URL: #59557 Reviewed-By: RenΓ© <contact.9a5d6388@renegade334.me.uk>
1 parent 9209cc4 commit 2de1d76

1 file changed

Lines changed: 24 additions & 4 deletions

File tree

β€Ždoc/api/fs.mdβ€Ž

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1183,6 +1183,10 @@ changes:
11831183
Calls `filehandle.close()` and returns a promise that fulfills when the
11841184
filehandle is closed.
11851185
1186+
This method enables the filehandle to be used with [`await using`][], which
1187+
will automatically close the file when the scope exits. For more information,
1188+
see the [MDN documentation on `using` statements][`using`].
1189+
11861190
### `fsPromises.access(path[, mode])`
11871191
11881192
<!-- YAML
@@ -1661,10 +1665,11 @@ directory cannot be deleted, disposal will throw an error. The object has an
16611665
async `remove()` method which will perform the same task.
16621666
16631667
Both this function and the disposal function on the resulting object are
1664-
async, so it should be used with `await` + `await using` as in
1668+
async, so it should be used with `await` + [`await using`][] as in
16651669
`await using dir =awaitfsPromises.mkdtempDisposable('prefix')`.
16661670
1667-
<!-- TODO: link MDN docs for disposables once https://github.com/mdn/content/pull/38027 lands -->
1671+
See the [MDN documentation on `using` statements][`using`] for more information about
1672+
explicit resource management.
16681673
16691674
For detailed information, see the documentation of [`fsPromises.mkdtemp()`][].
16701675
@@ -6393,12 +6398,13 @@ removed if it still exists. If the directory cannot be deleted, disposal will
63936398
throw an error. The object has a `remove()` method which will perform the same
63946399
task.
63956400
6396-
<!-- TODO: link MDN docs for disposables once https://github.com/mdn/content/pull/38027 lands -->
6401+
See the [MDN documentation on `using` statements][`using`] for more information about
6402+
explicit resource management.
63976403
63986404
For detailed information, see the documentation of [`fs.mkdtemp()`][].
63996405
64006406
There is no callback-based version of this API because it is designed for use
6401-
with the `using` syntax.
6407+
with the [`using`][] syntax.
64026408
64036409
The optional `options` argument can be a string specifying an encoding, or an
64046410
object with an `encoding` property specifying the character encoding to use.
@@ -7273,6 +7279,10 @@ changes:
72737279
Calls `dir.close()` if the directory handle is open, and returns a promise that
72747280
fulfills when disposal is complete.
72757281
7282+
This method enables the directory to be used with [`await using`][], which
7283+
will automatically close the directory when the scope exits. For more
7284+
information, see the [MDN documentation on `using` statements][`using`].
7285+
72767286
#### `dir[Symbol.dispose]()`
72777287
72787288
<!-- YAML
@@ -7286,6 +7296,10 @@ changes:
72867296
Calls `dir.closeSync()` if the directory handle is open, and returns
72877297
`undefined`.
72887298
7299+
This method enables the directory to be used with [`using`][], which
7300+
will automatically close the directory when the scope exits. For more
7301+
information, see the [MDN documentation on `using` statements][`using`].
7302+
72897303
### Class: `fs.Dirent`
72907304
72917305
<!-- YAML
@@ -8397,6 +8411,10 @@ the `data` argument must be a {Buffer}.
83978411
83988412
Calls `utf8Stream.destroy()`.
83998413
8414+
This method enables the stream to be used with [`using`][], which
8415+
will automatically destroy the stream when the scope exits. For more
8416+
information, see the [MDN documentation on `using` statements][`using`].
8417+
84008418
### Class: `fs.WriteStream`
84018419
84028420
<!-- YAML
@@ -9213,6 +9231,7 @@ the file contents.
92139231
[`Number.MAX_SAFE_INTEGER`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER
92149232
[`ReadDirectoryChangesW`]: https://docs.microsoft.com/en-us/windows/desktop/api/winbase/nf-winbase-readdirectorychangesw
92159233
[`UV_THREADPOOL_SIZE`]: cli.md#uv_threadpool_sizesize
9234+
[`await using`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/await_using
92169235
[`event ports`]: https://illumos.org/man/port_create
92179236
[`filehandle.createReadStream()`]: #filehandlecreatereadstreamoptions
92189237
[`filehandle.createWriteStream()`]: #filehandlecreatewritestreamoptions
@@ -9272,6 +9291,7 @@ the file contents.
92729291
[`stream/iter pipeTo()`]: stream_iter.md#pipetosource-transforms-writer-options
92739292
[`stream/iter pull()`]: stream_iter.md#pullsource-transforms-options
92749293
[`stream/iter pullSync()`]: stream_iter.md#pullsyncsource-transforms
9294+
[`using`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/using
92759295
[`util.promisify()`]: util.md#utilpromisifyoriginal
92769296
[bigints]: https://tc39.github.io/proposal-bigint
92779297
[caveats]: #caveats

0 commit comments

Comments
Β (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Commit 2de1d76

Browse files
lluisemperaduh95
authored andcommitted
doc: add MDN links for explicit resource management in fs
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: #59556 PR-URL: #59557 Reviewed-By: RenΓ© <contact.9a5d6388@renegade334.me.uk>
1 parent 9209cc4 commit 2de1d76

1 file changed

Lines changed: 24 additions & 4 deletions

File tree

β€Ždoc/api/fs.mdβ€Ž

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1183,6 +1183,10 @@ changes:
11831183
Calls `filehandle.close()` and returns a promise that fulfills when the
11841184
filehandle is closed.
11851185
1186+
This method enables the filehandle to be used with [`await using`][], which
1187+
will automatically close the file when the scope exits. For more information,
1188+
see the [MDN documentation on `using` statements][`using`].
1189+
11861190
### `fsPromises.access(path[, mode])`
11871191
11881192
<!-- YAML
@@ -1661,10 +1665,11 @@ directory cannot be deleted, disposal will throw an error. The object has an
16611665
async `remove()` method which will perform the same task.
16621666
16631667
Both this function and the disposal function on the resulting object are
1664-
async, so it should be used with `await` + `await using` as in
1668+
async, so it should be used with `await` + [`await using`][] as in
16651669
`await using dir =awaitfsPromises.mkdtempDisposable('prefix')`.
16661670
1667-
<!-- TODO: link MDN docs for disposables once https://github.com/mdn/content/pull/38027 lands -->
1671+
See the [MDN documentation on `using` statements][`using`] for more information about
1672+
explicit resource management.
16681673
16691674
For detailed information, see the documentation of [`fsPromises.mkdtemp()`][].
16701675
@@ -6393,12 +6398,13 @@ removed if it still exists. If the directory cannot be deleted, disposal will
63936398
throw an error. The object has a `remove()` method which will perform the same
63946399
task.
63956400
6396-
<!-- TODO: link MDN docs for disposables once https://github.com/mdn/content/pull/38027 lands -->
6401+
See the [MDN documentation on `using` statements][`using`] for more information about
6402+
explicit resource management.
63976403
63986404
For detailed information, see the documentation of [`fs.mkdtemp()`][].
63996405
64006406
There is no callback-based version of this API because it is designed for use
6401-
with the `using` syntax.
6407+
with the [`using`][] syntax.
64026408
64036409
The optional `options` argument can be a string specifying an encoding, or an
64046410
object with an `encoding` property specifying the character encoding to use.
@@ -7273,6 +7279,10 @@ changes:
72737279
Calls `dir.close()` if the directory handle is open, and returns a promise that
72747280
fulfills when disposal is complete.
72757281
7282+
This method enables the directory to be used with [`await using`][], which
7283+
will automatically close the directory when the scope exits. For more
7284+
information, see the [MDN documentation on `using` statements][`using`].
7285+
72767286
#### `dir[Symbol.dispose]()`
72777287
72787288
<!-- YAML
@@ -7286,6 +7296,10 @@ changes:
72867296
Calls `dir.closeSync()` if the directory handle is open, and returns
72877297
`undefined`.
72887298
7299+
This method enables the directory to be used with [`using`][], which
7300+
will automatically close the directory when the scope exits. For more
7301+
information, see the [MDN documentation on `using` statements][`using`].
7302+
72897303
### Class: `fs.Dirent`
72907304
72917305
<!-- YAML
@@ -8397,6 +8411,10 @@ the `data` argument must be a {Buffer}.
83978411
83988412
Calls `utf8Stream.destroy()`.
83998413
8414+
This method enables the stream to be used with [`using`][], which
8415+
will automatically destroy the stream when the scope exits. For more
8416+
information, see the [MDN documentation on `using` statements][`using`].
8417+
84008418
### Class: `fs.WriteStream`
84018419
84028420
<!-- YAML
@@ -9213,6 +9231,7 @@ the file contents.
92139231
[`Number.MAX_SAFE_INTEGER`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER
92149232
[`ReadDirectoryChangesW`]: https://docs.microsoft.com/en-us/windows/desktop/api/winbase/nf-winbase-readdirectorychangesw
92159233
[`UV_THREADPOOL_SIZE`]: cli.md#uv_threadpool_sizesize
9234+
[`await using`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/await_using
92169235
[`event ports`]: https://illumos.org/man/port_create
92179236
[`filehandle.createReadStream()`]: #filehandlecreatereadstreamoptions
92189237
[`filehandle.createWriteStream()`]: #filehandlecreatewritestreamoptions
@@ -9272,6 +9291,7 @@ the file contents.
92729291
[`stream/iter pipeTo()`]: stream_iter.md#pipetosource-transforms-writer-options
92739292
[`stream/iter pull()`]: stream_iter.md#pullsource-transforms-options
92749293
[`stream/iter pullSync()`]: stream_iter.md#pullsyncsource-transforms
9294+
[`using`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/using
92759295
[`util.promisify()`]: util.md#utilpromisifyoriginal
92769296
[bigints]: https://tc39.github.io/proposal-bigint
92779297
[caveats]: #caveats

0 commit comments

Comments
Β (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Commit 2de1d76

Browse files
lluisemperaduh95
authored andcommitted
doc: add MDN links for explicit resource management in fs
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: #59556 PR-URL: #59557 Reviewed-By: RenΓ© <contact.9a5d6388@renegade334.me.uk>
1 parent 9209cc4 commit 2de1d76

1 file changed

Lines changed: 24 additions & 4 deletions

File tree

β€Ždoc/api/fs.mdβ€Ž

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1183,6 +1183,10 @@ changes:
11831183
Calls `filehandle.close()` and returns a promise that fulfills when the
11841184
filehandle is closed.
11851185
1186+
This method enables the filehandle to be used with [`await using`][], which
1187+
will automatically close the file when the scope exits. For more information,
1188+
see the [MDN documentation on `using` statements][`using`].
1189+
11861190
### `fsPromises.access(path[, mode])`
11871191
11881192
<!-- YAML
@@ -1661,10 +1665,11 @@ directory cannot be deleted, disposal will throw an error. The object has an
16611665
async `remove()` method which will perform the same task.
16621666
16631667
Both this function and the disposal function on the resulting object are
1664-
async, so it should be used with `await` + `await using` as in
1668+
async, so it should be used with `await` + [`await using`][] as in
16651669
`await using dir =awaitfsPromises.mkdtempDisposable('prefix')`.
16661670
1667-
<!-- TODO: link MDN docs for disposables once https://github.com/mdn/content/pull/38027 lands -->
1671+
See the [MDN documentation on `using` statements][`using`] for more information about
1672+
explicit resource management.
16681673
16691674
For detailed information, see the documentation of [`fsPromises.mkdtemp()`][].
16701675
@@ -6393,12 +6398,13 @@ removed if it still exists. If the directory cannot be deleted, disposal will
63936398
throw an error. The object has a `remove()` method which will perform the same
63946399
task.
63956400
6396-
<!-- TODO: link MDN docs for disposables once https://github.com/mdn/content/pull/38027 lands -->
6401+
See the [MDN documentation on `using` statements][`using`] for more information about
6402+
explicit resource management.
63976403
63986404
For detailed information, see the documentation of [`fs.mkdtemp()`][].
63996405
64006406
There is no callback-based version of this API because it is designed for use
6401-
with the `using` syntax.
6407+
with the [`using`][] syntax.
64026408
64036409
The optional `options` argument can be a string specifying an encoding, or an
64046410
object with an `encoding` property specifying the character encoding to use.
@@ -7273,6 +7279,10 @@ changes:
72737279
Calls `dir.close()` if the directory handle is open, and returns a promise that
72747280
fulfills when disposal is complete.
72757281
7282+
This method enables the directory to be used with [`await using`][], which
7283+
will automatically close the directory when the scope exits. For more
7284+
information, see the [MDN documentation on `using` statements][`using`].
7285+
72767286
#### `dir[Symbol.dispose]()`
72777287
72787288
<!-- YAML
@@ -7286,6 +7296,10 @@ changes:
72867296
Calls `dir.closeSync()` if the directory handle is open, and returns
72877297
`undefined`.
72887298
7299+
This method enables the directory to be used with [`using`][], which
7300+
will automatically close the directory when the scope exits. For more
7301+
information, see the [MDN documentation on `using` statements][`using`].
7302+
72897303
### Class: `fs.Dirent`
72907304
72917305
<!-- YAML
@@ -8397,6 +8411,10 @@ the `data` argument must be a {Buffer}.
83978411
83988412
Calls `utf8Stream.destroy()`.
83998413
8414+
This method enables the stream to be used with [`using`][], which
8415+
will automatically destroy the stream when the scope exits. For more
8416+
information, see the [MDN documentation on `using` statements][`using`].
8417+
84008418
### Class: `fs.WriteStream`
84018419
84028420
<!-- YAML
@@ -9213,6 +9231,7 @@ the file contents.
92139231
[`Number.MAX_SAFE_INTEGER`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER
92149232
[`ReadDirectoryChangesW`]: https://docs.microsoft.com/en-us/windows/desktop/api/winbase/nf-winbase-readdirectorychangesw
92159233
[`UV_THREADPOOL_SIZE`]: cli.md#uv_threadpool_sizesize
9234+
[`await using`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/await_using
92169235
[`event ports`]: https://illumos.org/man/port_create
92179236
[`filehandle.createReadStream()`]: #filehandlecreatereadstreamoptions
92189237
[`filehandle.createWriteStream()`]: #filehandlecreatewritestreamoptions
@@ -9272,6 +9291,7 @@ the file contents.
92729291
[`stream/iter pipeTo()`]: stream_iter.md#pipetosource-transforms-writer-options
92739292
[`stream/iter pull()`]: stream_iter.md#pullsource-transforms-options
92749293
[`stream/iter pullSync()`]: stream_iter.md#pullsyncsource-transforms
9294+
[`using`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/using
92759295
[`util.promisify()`]: util.md#utilpromisifyoriginal
92769296
[bigints]: https://tc39.github.io/proposal-bigint
92779297
[caveats]: #caveats

0 commit comments

Comments
Β (0)