Browse Source

docs: clarify usage of stream.Writable.write

Add separate sample code for the write-after-end case to avoid
confusion.

PR: #15517
PR-URL: https://github.com/joyent/node/pull/15517
Reviewed-By: Julien Gilli <jgilli@fastmail.fm>
v0.10.39-release
AlexKVal 10 years ago
committed by Julien Gilli
parent
commit
9800e0b428
  1. 12
      doc/api/stream.markdown

12
doc/api/stream.markdown

@ -517,14 +517,20 @@ function writeOneMillionTimes(writer, data, encoding, callback) {
Call this method when no more data will be written to the stream. If
supplied, the callback is attached as a listener on the `finish` event.
Calling [`write()`][] after calling [`end()`][] will raise an error.
```javascript
// write 'hello, ' and then end with 'world!'
var file = fs.createWriteStream('example.txt');
file.write('hello, ');
file.end('world!');
// writing more now is not allowed!
```
Calling [`write()`][] after calling [`end()`][] will raise an error:
```javascript
// end with 'world!' and then write with 'hello, ' will raise an error
var file = fs.createWriteStream('example.txt');
file.end('world!');
file.write('hello, ');
```
#### Event: 'finish'

Loading…
Cancel
Save