node/doc/api
Robert Nagy 5133e783ba doc: add note about forwarding stream options
It is a common and unfortunate pattern to simply just forward
any and all options into the base constructor without taking
into account whether these options might conflict with basic
stream assumptions.

PR-URL: https://github.com/nodejs/node/pull/29857
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2019-10-10 17:22:23 -07:00
..
addons.md doc: use consistent unordered list style 2019-09-16 11:24:54 -07:00
assert.md doc: add explicit bracket for markdown reference links 2019-10-03 22:57:33 -07:00
async_hooks.md doc: async_hooks.createHook promiseResolve option 2019-09-06 06:05:58 +02:00
buffer.md test: remove spaces inside code span elements 2019-10-09 20:55:16 -07:00
child_process.md doc: fix require call for spawn() in code example 2019-09-22 10:52:17 -07:00
cli.md esm: unflag --experimental-exports 2019-10-10 16:29:08 -07:00
cluster.md doc: exitedAfterDisconnect value can be false 2019-09-09 05:47:45 +02:00
console.md doc: space around lists 2019-09-09 16:45:24 -07:00
crypto.md doc: add explicit bracket for markdown reference links 2019-10-03 22:57:33 -07:00
debugger.md doc: change the 'txt' to 'console' for a command 2019-09-03 14:21:34 -07:00
deprecations.md doc: add explicit bracket for markdown reference links 2019-10-03 22:57:33 -07:00
dgram.md doc: fix nits in dgram.md 2019-10-01 14:35:04 -07:00
dns.md doc: use consistent unordered list style 2019-09-16 11:24:54 -07:00
documentation.md doc: remove multiple consecutive blank lines 2019-08-31 15:27:58 -07:00
domain.md doc: add extends for derived classes 2019-09-01 08:18:10 -07:00
errors.md fs: introduce opendir() and fs.Dir 2019-10-08 10:34:48 -07:00
esm.md Revert "esm: remove experimental status from JSON modules" 2019-10-08 21:18:04 -07:00
events.md doc: unify place of stability notes 2019-10-03 13:59:40 -07:00
fs.md doc: add more info to fs.Dir and fix typos 2019-10-09 20:42:28 -07:00
globals.md doc: add explicit bracket for markdown reference links 2019-10-03 22:57:33 -07:00
http2.md http2: allow passing FileHandle to respondWithFD 2019-10-09 23:54:43 +02:00
http.md doc: add explicit bracket for markdown reference links 2019-10-03 22:57:33 -07:00
https.md doc: use consistent unordered list style 2019-09-16 11:24:54 -07:00
index.md doc: add node-report documentation 2019-01-18 10:35:55 +05:30
inspector.md doc: add explicit bracket for markdown reference links 2019-10-03 22:57:33 -07:00
intl.md tools: support full-icu by default 2019-10-03 15:21:26 -07:00
modules.md esm: unflag --experimental-exports 2019-10-10 16:29:08 -07:00
n-api.md doc: reuse link indexes for n-api.md 2019-10-03 16:15:24 -07:00
net.md doc: fix nits in net.md 2019-09-18 08:19:58 -07:00
os.md doc: improve os.homedir() docs 2019-07-17 21:48:40 -07:00
path.md doc: fix extname with the correct description 2019-04-20 17:01:09 +03:00
perf_hooks.md doc: space around lists 2019-09-09 16:45:24 -07:00
policy.md doc: remove multiple consecutive blank lines 2019-08-31 15:27:58 -07:00
process.md doc: add explicit bracket for markdown reference links 2019-10-03 22:57:33 -07:00
punycode.md doc: prevent some redirections 2018-07-14 22:57:03 +03:00
querystring.md doc: space around lists 2019-09-09 16:45:24 -07:00
readline.md doc: add explicit bracket for markdown reference links 2019-10-03 22:57:33 -07:00
repl.md doc: unify place of stability notes 2019-10-03 13:59:40 -07:00
report.md http: remove legacy parser 2019-09-20 20:18:35 +02:00
stream.md doc: add note about forwarding stream options 2019-10-10 17:22:23 -07:00
string_decoder.md string_decoder: support typed array or data view 2018-09-17 17:48:44 +02:00
synopsis.md doc: move Usage and Example to same header level 2019-07-09 19:45:20 -07:00
timers.md doc: add explicit bracket for markdown reference links 2019-10-03 22:57:33 -07:00
tls.md doc: fix tls version values 2019-10-10 15:03:00 +02:00
tracing.md doc: add explicit bracket for markdown reference links 2019-10-03 22:57:33 -07:00
tty.md doc: space around lists 2019-09-09 16:45:24 -07:00
url.md doc: remove misleading paragraph about the Legacy URL API 2019-10-08 06:18:01 +02:00
util.md doc: add explicit bracket for markdown reference links 2019-10-03 22:57:33 -07:00
v8.md doc: space around lists 2019-09-09 16:45:24 -07:00
vm.md vm: refactor SourceTextModule 2019-10-02 15:54:35 -07:00
worker_threads.md doc: use consistent unordered list style 2019-09-16 11:24:54 -07:00
zlib.md doc: use consistent unordered list style 2019-09-16 11:24:54 -07:00