OSSForks/node
1
0
Fork 0
mirror of https://github.com/zebrajr/node.git synced 2025-12-06 12:20:27 +01:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

doc: update abort signal in fs promise api example

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/38669
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
This commit is contained in:
Moritz Kneilmann 2021-05-13 15:26:26 +02:00 committed by James M Snell
parent 9d85710899
commit ceae1b47b7
No known key found for this signature in database
GPG Key ID: 7341B15C070877AC
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/api/fs.md
View File

@ -980,12 +980,15 @@ import { readFile } from 'fs/promises';
try {
const controller = new AbortController();
const signal = controller.signal;
readFile(fileName, { signal });
const { signal } = controller;
const promise = readFile(fileName, { signal });
// Abort the request
// Abort the request before the promise settles.
controller.abort();
await promise;
} catch (err) {
// When a request is aborted - err is an AbortError
console.error(err);
}
```
@ -999,7 +1002,6 @@ Any specified {FileHandle} has to support reading.
<!-- YAML
added: v10.0.0
-->
* `path` {string|Buffer|URL}
* `options` {string|Object}
* `encoding` {string} **Default:** `'utf8'`
@ -1316,8 +1318,12 @@ try {
const controller = new AbortController();
const { signal } = controller;
const data = new Uint8Array(Buffer.from('Hello Node.js'));
writeFile('message.txt', data, { signal });
const promise = writeFile('message.txt', data, { signal });
// Abort the request before the promise settles.
controller.abort();
await promise;
} catch (err) {
// When a request is aborted - err is an AbortError
console.error(err);