Skip to content

Commit

Permalink
doc: update fs.open() changes record for optional 'flags'
Browse files Browse the repository at this point in the history
Was missed on original PR.

Ref: #23767

PR-URL: #24240
Refs: #23767
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
rvagg authored and BridgeAR committed Nov 13, 2018
1 parent 9e89132 commit c68b0ae
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions doc/api/fs.md
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

0 comments on commit c68b0ae

Please sign in to comment.