Gireesh Punathil 66e6d7835e doc: warn against streaming from character devices ...

charcter device streaming works just like any other streams, but hangs
on the close callsite due to the worker thread being blocked on the read
and main thread waiting for any async event that may not occur.

Document this behavior and suggest a potential workaround.

Fixes: https://github.com/nodejs/node/issues/15439
PR-URL: https://github.com/nodejs/node/pull/21212

Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>

2018-08-28 18:54:47 +05:30

..

addons.md

src: add context-aware init macro and doc

2018-07-03 18:34:50 -04:00

assert.md

assert: multiple improvements

2018-08-04 10:04:32 +02:00

async_hooks.md

doc: prevent some redirections

2018-07-14 22:57:03 +03:00

buffer.md

doc: list encodings supported by buffer.transcode

2018-08-11 17:08:15 -07:00

child_process.md

child_process: allow typed arrays for input

2018-08-27 23:40:10 +02:00

cli.md

doc: add doc for --loader option

2018-08-18 11:15:37 +03:00

cluster.md

child_process: change windowsHide default to true

2018-06-20 11:02:01 -04:00

console.md

2018-07-18, Version 10.7.0 (Current)

2018-07-18 20:17:23 +02:00

crypto.md

2018-08-15, Version 10.9.0 (Current)

2018-08-16 11:52:38 +10: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 _toBuf

2018-08-27 13:37:20 +02:00

dgram.md

doc: unify optional arguments format in headings

2018-08-19 21:45:39 +03:00

dns.md

doc: declare all parameter types

2018-07-15 23:57:35 +03:00

documentation.md

fs: undeprecate lchown()

2018-06-27 11:37:17 -04:00

domain.md

doc: add more missing backticks

2018-05-03 02:12:07 +03:00

errors.md

child_process: allow typed arrays for input

2018-08-27 23:40:10 +02: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: warn against streaming from character devices

2018-08-28 18:54:47 +05:30

globals.md

…

http2.md

doc: simplify http2 wording and formatting

2018-08-26 23:10:33 -07:00

http.md

doc: state callback behavior on empty buffer

2018-08-23 17:25:02 +03:00

https.md

2018-08-15, Version 10.9.0 (Current)

2018-08-16 11:52:38 +10: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: fix module.children description

2018-07-11 00:31:59 +02:00

n-api.md

doc: update wrapping-related documentation

2018-08-21 13:56:56 -04:00

net.md

doc: fix return type of server.address()

2018-08-03 17:15:21 +08:00

os.md

os: add os.{get,set}Priority()

2018-08-22 17:27:16 -04:00

path.md

doc: prevent some redirections

2018-07-14 22:57:03 +03:00

perf_hooks.md

perf_hooks: remove less useful bootstrap marks

2018-06-15 09:05:19 -07:00

process.md

process: add allowedNodeEnvironmentFlags property

2018-08-24 18:15:19 -07:00

punycode.md

doc: prevent some redirections

2018-07-14 22:57:03 +03:00

querystring.md

…

readline.md

doc: add more missing backticks

2018-05-03 02:12:07 +03:00

repl.md

doc: unify optional arguments format in headings

2018-08-19 21:45:39 +03:00

stream.md

stream: restore flow if there are 'data' handlers after once('readable')

2018-08-21 22:36:13 -07:00

string_decoder.md

…

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: prevent some redirections

2018-07-14 22:57:03 +03:00

tracing.md

trace_events: add node.promises category, rejection counter

2018-08-07 07:43:18 -07:00

tty.md

doc: declare all parameter types

2018-07-15 23:57:35 +03:00

url.md

doc: clarify that new URL().port could be an empty string

2018-08-17 13:00:31 +02:00

util.md

test: remove harmony flags

2018-08-15 17:39:59 +02:00

v8.md

doc: declare all parameter types

2018-07-15 23:57:35 +03:00

vm.md

src: implement query callbacks for vm

2018-08-23 23:09:19 -04:00

worker_threads.md

doc: fix worker example to receive message

2018-07-18 17:45:30 +02:00

zlib.md

doc: unify optional arguments format in headings

2018-08-19 21:45:39 +03:00