daohualiuxiang
/
node
mirror of https://github.com/nodejs/node.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: stream writev cleanups

archived-io.js-v0.10
isaacs 2013-04-27 23:41:16 -07:00
parent f2d5cea73a
commit 9cfc92979b
1 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/api/stream.markdown
View File

@ -494,17 +494,16 @@ the class that defines it, and should not be called directly by user
programs. However, you **are** expected to override this method in programs. However, you **are** expected to override this method in
your own extension classes. your own extension classes.
### writable.\_writev(chunks, callback) ### writable.\_writev(chunks, callback)
* `chunks` {Array} The chunks to be written, each chunk should have following * `chunks` {Array} The chunks to be written. Each chunk has following
format: `{ chunk: ..., encoding: ... }`. format: `{ chunk: ..., encoding: ... }`.
* `callback` {Function} Call this function (optionally with an error * `callback` {Function} Call this function (optionally with an error
argument) when you are done processing the supplied chunks. argument) when you are done processing the supplied chunks.
NOTE: This function is completely optional to implement. Even more, in the most This function is completely optional to implement. In the most cases
of the cases you won't need it. it is unnecessary. If implemented, it will be called with all the
chunks that are buffered in the write queue.
### writable.write(chunk, [encoding], [callback]) ### writable.write(chunk, [encoding], [callback])
@ -527,7 +526,7 @@ the `highWaterMark` option provided to the constructor.
Forces buffering of all writes. Forces buffering of all writes.
NOTE: buffered data will be flushed either at `.uncork()` or at `.end()` call. Buffered data will be flushed either at `.uncork()` or at `.end()` call.
### writable.uncork() ### writable.uncork()