node/doc/api
Anna Henningsen f2338ed195
doc: fix up warning text about character devices
The text contained a number of inaccuracies:

- The main thread is never blocked by a stream close.
- There is no such thing as an EOF character on the OS level,
  the libuv level, or the Node.js stream level.
- These streams *do* respond to `.close()`, but pending
  reads can delay this indefinitely.
- Pushing a random character into the stream works only when
  the source data can be controlled; Using the JS `.push()`
  method is something different, and does not “unblock” any threads.

Refs: https://github.com/nodejs/node/pull/21212

PR-URL: https://github.com/nodejs/node/pull/22569
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2018-08-31 19:15:57 +02:00
..
addons.md src: add context-aware init macro and doc 2018-07-03 18:34:50 -04:00
assert.md doc: remove redundant 'Example:' and similar notes 2018-08-29 16:53:03 +03:00
async_hooks.md doc: remove redundant 'Example:' and similar notes 2018-08-29 16:53:03 +03:00
buffer.md doc: list encodings supported by buffer.transcode 2018-08-11 17:08:15 -07:00
child_process.md doc: remove redundant 'Example:' and similar notes 2018-08-29 16:53:03 +03:00
cli.md doc: add doc for --loader option 2018-08-18 11:15:37 +03:00
cluster.md doc: remove redundant 'Example:' and similar notes 2018-08-29 16:53:03 +03:00
console.md 2018-07-18, Version 10.7.0 (Current) 2018-07-18 20:17:23 +02:00
crypto.md doc: remove redundant 'Example:' and similar notes 2018-08-29 16:53:03 +03:00
debugger.md inspector: use js_app.html as the landing page for chrome devtools 2018-06-28 09:24:02 -03:00
deprecations.md crypto: deprecate aliases for randomBytes 2018-08-30 17:19:51 +02:00
dgram.md doc: remove redundant 'Example:' and similar notes 2018-08-29 16:53:03 +03:00
dns.md doc: declare all parameter types 2018-07-15 23:57:35 +03:00
documentation.md doc: make Stability Index more concise 2018-08-30 20:15:40 +01:00
domain.md doc: remove redundant 'Example:' and similar notes 2018-08-29 16:53:03 +03:00
errors.md doc: remove redundant 'Example:' and similar notes 2018-08-29 16:53:03 +03:00
esm.md esm: provide named exports for builtin libs 2018-05-11 12:06:18 -05:00
events.md doc: declare all parameter types 2018-07-15 23:57:35 +03:00
fs.md doc: fix up warning text about character devices 2018-08-31 19:15:57 +02:00
globals.md 2018-04-24, Version 10.0.0 (Current) 2018-04-24 12:02:31 -07:00
http2.md doc: remove redundant 'Example:' and similar notes 2018-08-29 16:53:03 +03:00
http.md doc: remove redundant 'Example:' and similar notes 2018-08-29 16:53:03 +03:00
https.md doc: remove redundant 'Example:' and similar notes 2018-08-29 16:53:03 +03:00
index.md doc: prevent some redirections 2018-07-14 22:57:03 +03:00
inspector.md doc: fix structure and formatting in inspector.md 2018-07-08 21:56:10 +03:00
intl.md doc: bump ICU version to avoid confusion 2018-08-14 22:44:58 +03:00
modules.md doc: remove redundant 'Example:' and similar notes 2018-08-29 16:53:03 +03:00
n-api.md doc: remove redundant 'Example:' and similar notes 2018-08-29 16:53:03 +03:00
net.md doc: remove redundant 'Example:' and similar notes 2018-08-29 16:53:03 +03:00
os.md doc: remove redundant 'Example:' and similar notes 2018-08-29 16:53:03 +03:00
path.md doc: remove redundant 'Example:' and similar notes 2018-08-29 16:53:03 +03:00
perf_hooks.md perf_hooks: remove less useful bootstrap marks 2018-06-15 09:05:19 -07:00
process.md doc: remove redundant 'Example:' and similar notes 2018-08-29 16:53:03 +03:00
punycode.md doc: prevent some redirections 2018-07-14 22:57:03 +03:00
querystring.md doc: remove redundant 'Example:' and similar notes 2018-08-29 16:53:03 +03:00
readline.md doc: remove redundant 'Example:' and similar notes 2018-08-29 16:53:03 +03:00
repl.md doc: remove redundant 'Example:' and similar notes 2018-08-29 16:53:03 +03:00
stream.md doc: remove redundant 'Example:' and similar notes 2018-08-29 16:53:03 +03:00
string_decoder.md doc: unify section structures 2018-04-15 02:37:50 +03:00
synopsis.md doc: add missing periods or colons 2018-05-02 06:17:08 +03:00
timers.md doc: prevent some redirections 2018-07-14 22:57:03 +03:00
tls.md doc: remove redundant 'Example:' and similar notes 2018-08-29 16:53:03 +03:00
tracing.md doc: remove redundant 'Example:' and similar notes 2018-08-29 16:53:03 +03:00
tty.md doc: declare all parameter types 2018-07-15 23:57:35 +03:00
url.md doc: remove redundant 'Example:' and similar notes 2018-08-29 16:53:03 +03:00
util.md doc: remove redundant 'Example:' and similar notes 2018-08-29 16:53:03 +03:00
v8.md doc: declare all parameter types 2018-07-15 23:57:35 +03:00
vm.md vm: add bindings for v8::CompileFunctionInContext 2018-08-29 16:41:01 +02:00
worker_threads.md doc: remove redundant 'Example:' and similar notes 2018-08-29 16:53:03 +03:00
zlib.md doc: unify optional arguments format in headings 2018-08-19 21:45:39 +03:00