Skip to content

doc: clarify FileHandle error handling #63719

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

Open
bobu-putheeckal wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −0
Open

doc: clarify FileHandle error handling #63719

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
6 changes: 6 additions & 0 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,9 @@ added: v10.0.0
Closes the file handle after waiting for any pending operation on the handle to
complete.

The promise is rejected if closing the file handle fails. In case of an error,
the error's `code` will be one of [Common System Errors][].

```mjs
import { open } from 'node:fs/promises';

Expand Down Expand Up @@ -795,6 +798,9 @@ changes:
* `signal` {AbortSignal} An AbortSignal to cancel the operation. **Default:** `undefined`.
* Returns: {Promise} Fulfills with an {fs.Stats} for the file.

The promise is rejected if the stat operation fails. In case of an error, the
error's `code` will be one of [Common System Errors][].

#### `filehandle.sync()`

<!-- YAML
Expand Down
Loading