1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: update writable streams default encoding

Browse Source 
Setting the default encoding for a writable stream does
not return a boolean (true if successful or false if not)
as the docs indicate. Instead, if the operation is successful
nothing is returned and the method throws an error when
something goes wrong.

This stems from a contribution that was tweaked but the
docs were never updated accordingly.

PR-URL: https://github.com/iojs/io.js/pull/502
Reviewed-By: Rod Vagg <rod@vagg.org>
This commit is contained in:
Johnny Ray Austin 2015-01-18 20:48:32 -05:00 committed by Rod Vagg
parent 18552677d7
commit 84b05d48d9
1 changed files with 1 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/api/stream.markdown
View File

@ -567,10 +567,8 @@ Flush all data, buffered since `.cork()` call.
#### writable.setDefaultEncoding(encoding)
* `encoding` {String} The new default encoding
* Return: `Boolean`
Sets the default encoding for a writable stream. Returns `true` if the encoding
is valid and is set. Otherwise returns `false`.
Sets the default encoding for a writable stream.
#### writable.end([chunk][, encoding][, callback])