Skip to content
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

Jump to bottom

doc: update fs.open() changes record for optional 'flags' #24240

Closed
wants to merge 4 commits into from
Closed

doc: update fs.open() changes record for optional 'flags' #24240

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4c9089d
doc: update fs.open() changes record for optional 'flags'
rvagg Nov 8, 2018
f87385f
fixup! doc: update fs.open() changes record for optional 'flags'
rvagg Nov 9, 2018
8681024
fixup! doc: update fs.open() changes record for optional 'flags'
rvagg Nov 11, 2018
a39e208
fixup! doc: update fs.open() changes record for optional 'flags'
rvagg Nov 12, 2018
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
14 changes: 14 additions & 0 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2313,6 +2313,9 @@ object with an `encoding` property specifying the character encoding to use.
<!-- YAML
added: v0.0.2
changes:
- version: v11.1.0
pr-url: https://github.com/nodejs/node/pull/23767
description: The `flags` argument is now optional and defaults to `'r'`.
- version: v9.9.0
pr-url: https://github.com/nodejs/node/pull/18801
description: The `as` and `as+` modes are supported now.
Expand Down Expand Up @@ -2350,6 +2353,12 @@ Functions based on `fs.open()` exhibit this behavior as well:
<!-- YAML
added: v0.1.21
changes:
- version: v11.1.0
pr-url: https://github.com/nodejs/node/pull/23767
description: The `flags` argument is now optional and defaults to `'r'`.
- version: v9.9.0
pr-url: https://github.com/nodejs/node/pull/18801
description: The `as` and `as+` modes are supported now.
- version: v7.6.0
pr-url: https://github.com/nodejs/node/pull/10739
description: The `path` parameter can be a WHATWG `URL` object using `file:`
Expand Down Expand Up @@ -4211,10 +4220,15 @@ characters directly to the `prefix` string. For instance, given a directory
### fsPromises.open(path, flags[, mode])
<!-- YAML
added: v10.0.0
changes:
- version: v11.1.0
pr-url: https://github.com/nodejs/node/pull/23767
description: The `flags` argument is now optional and defaults to `'r'`.
-->

* `path` {string|Buffer|URL}
* `flags` {string|number} See [support of file system `flags`][].
**Default:** `'r'`.
* `mode` {integer} **Default:** `0o666` (readable and writable)
* Returns: {Promise}

Expand Down