Skip to content

Update abort signal in fs promise api example #38669

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 5 commits into from
Closed

Update abort signal in fs promise api example #38669

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a0e88ea
Update abort signal in fs promise api example
MoritzKn May 13, 2021
69795ff
Update doc/api/fs.md
MoritzKn May 13, 2021
b5ad79c
Update doc/api/fs.md
MoritzKn May 13, 2021
584a227
Remove trailing spaces
MoritzKn May 13, 2021
682a00e
Update doc/api/fs.md
MoritzKn May 13, 2021
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
17 changes: 12 additions & 5 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}
```
Expand All @@ -999,7 +1002,7 @@ Any specified {FileHandle} has to support reading.
<!-- YAML
added: v10.0.0
-->

* `path` {string|Buffer|URL}
* `options` {string|Object}
* `encoding` {string} **Default:** `'utf8'`
Expand Down Expand Up @@ -1316,8 +1319,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);
Expand Down