Browse Source

doc: document the writable.end() callback function

Support for it was added in a9c4a20331.
v0.9.10-release
Nathan Rajlich 12 years ago
parent
commit
1ba39226b2
  1. 4
      doc/api/stream.markdown

4
doc/api/stream.markdown

@ -376,11 +376,13 @@ subsequent `'drain'` event will be emitted, are determined by the
`highWaterMark` and `lowWaterMark` options provided to the `highWaterMark` and `lowWaterMark` options provided to the
constructor. constructor.
### writable.end([chunk], [encoding]) ### writable.end([chunk], [encoding], [callback])
* `chunk` {Buffer | String} Optional final data to be written * `chunk` {Buffer | String} Optional final data to be written
* `encoding` {String} Optional. If `chunk` is a string, then encoding * `encoding` {String} Optional. If `chunk` is a string, then encoding
defaults to `'utf8'` defaults to `'utf8'`
* `callback` {Function} Optional. Called when the final chunk is
successfully written.
Call this method to signal the end of the data being written to the Call this method to signal the end of the data being written to the
stream. stream.

Loading…
Cancel
Save