Permalink
Browse files

doc,fs: rename defaultEncoding option to encoding

The documentation for `fs.createWriteStream()` references a
`defaultEncoding` as possible options property, but in reality
`encoding` property is expected and properly handled. This fix updates
the documentation to rename the `defaultEncoding` property to
`encoding`.

PR-URL: #14867
Fixes: #14611
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information...
azasypkin authored and MylesBorins committed Aug 16, 2017
1 parent 7621555 commit 205d5f674ae260dd3fc753d27673aed1b59f75ee
Showing with 3 additions and 3 deletions.
  1. +3 −3 doc/api/fs.md
View
@@ -835,7 +835,7 @@ changes:
* `path` {string|Buffer|URL}
* `options` {string|Object}
* `flags` {string}
* `defaultEncoding` {string}
* `encoding` {string}
* `fd` {integer}
* `mode` {integer}
* `autoClose` {boolean}
@@ -848,7 +848,7 @@ Returns a new [`WriteStream`][] object. (See [Writable Stream][]).
```js
const defaults = {
flags: 'w',
defaultEncoding: 'utf8',
encoding: 'utf8',
fd: null,
mode: 0o666,
autoClose: true
@@ -858,7 +858,7 @@ const defaults = {
`options` may also include a `start` option to allow writing data at
some position past the beginning of the file. Modifying a file rather
than replacing it may require a `flags` mode of `r+` rather than the
default mode `w`. The `defaultEncoding` can be any one of those accepted by
default mode `w`. The `encoding` can be any one of those accepted by
[`Buffer`][].
If `autoClose` is set to true (default behavior) on `error` or `end`

0 comments on commit 205d5f6

Please sign in to comment.