Skip to content

doc: error modes of writable #29745

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ronag wants to merge 8 commits into from
Closed

doc: error modes of writable #29745

Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
b693344
doc: error modes of writable
ronag Sep 28, 2019
43e0844
Apply suggestions from code review
ronag Sep 30, 2019
459ee59
Update doc/api/stream.md
ronag Oct 4, 2019
1bae447
fixup
ronag Nov 24, 2019
5f5e282
Update doc/api/stream.md
ronag Nov 24, 2019
e9ef938
fixup: formatting
ronag Nov 24, 2019
bdfb2d4
Update doc/api/stream.md
ronag Nov 24, 2019
6f797e4
Update doc/api/stream.md
ronag Dec 1, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions doc/api/stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -432,6 +432,19 @@ file.end('world!');
// Writing more now is not allowed!
```

[`stream.end()`][stream-end] will call it's callback and emit `'error'`
Comment thread
ronag marked this conversation as resolved.
Outdated
with (in order of precedence):
* `ERR_STREAM_WRITE_AFTER_END` if `chunk` is not nully and
[`stream.end()`][stream-end] has been called.
Comment thread
ronag marked this conversation as resolved.
Outdated
* `ERR_STREAM_DESTROYED` if `chunk` is not nully and
[`stream.destroy()`][writable-destroy] has been called.
* `ERR_INVALID_ARG_TYPE` if `chunk` is not nully and
`chunk` is not a `string` when not in `objectMode`.
Comment thread
lundibundi marked this conversation as resolved.
Outdated
* `ERR_STREAM_ALREADY_FINISHED` if
[`writable.writableFinished`][] is `true`.
* Any error emitted by the instance through `'error'` before
Comment thread
ronag marked this conversation as resolved.
Outdated
[`writable.writableFinished`][] is set to `true`.

##### writable.setDefaultEncoding(encoding)
<!-- YAML
added: v0.11.15
Expand Down Expand Up @@ -619,6 +632,15 @@ write('hello', () => {

A `Writable` stream in object mode will always ignore the `encoding` argument.

`stream.write()` will call it's callback and emit `'error'`
Copy link
Copy Markdown
Contributor

@yorkie yorkie Nov 24, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`stream.write()` will call it's callback and emit `'error'`
`stream.write()` will call its callback and emit `'error'`

with (in order of precedence):
* `ERR_STREAM_WRITE_AFTER_END` if [`stream.end()`][stream-end] has been called.
* `ERR_STREAM_DESTROYED` if [`stream.destroy()`][writable-destroy] has been
called.
* `ERR_STREAM_NULL_VALUES` if `chunk` is `null`.
* `ERR_INVALID_ARG_TYPE` if `chunk` is not a `string` when not in `objectMode`.
* Any error forwarded by `writable._write()`.
Comment thread
ronag marked this conversation as resolved.
Outdated

### Readable Streams

Readable streams are an abstraction for a *source* from which data is
Expand Down