node/doc/api
Sam Roberts 426ca0837a doc: clarify allowed encoding parameter types
This fixes the incorrect enumerations of their possible values, which
weren't up to date with the values actually supported. Also renamed
two arguments that used "format" when they meant "encoding".

PR-URL: https://github.com/nodejs/node/pull/24230
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
2018-11-09 15:57:17 -08:00
..
addons.md test: fix compiler warning in doc/api/addons.md 2018-10-11 05:18:11 +02:00
assert.md doc: remove notice of dashes in V8 options 2018-10-29 21:24:08 +00:00
async_hooks.md doc: correct async_hooks resource names 2018-11-02 22:58:44 +02:00
buffer.md 2018-10-23, Version 11.0.0 (Current) 2018-10-23 11:03:02 -07:00
child_process.md doc: remove notice of dashes in V8 options 2018-10-29 21:24:08 +00:00
cli.md doc: inspector security warning for changing host 2018-11-05 22:38:01 -08:00
cluster.md doc: make example more clarified in cluster.md 2018-10-28 22:26:09 -07:00
console.md 2018-07-18, Version 10.7.0 (Current) 2018-07-18 20:17:23 +02:00
crypto.md doc: clarify allowed encoding parameter types 2018-11-09 15:57:17 -08: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 doc: update missing deprecation 2018-10-27 09:02:10 -04:00
dgram.md doc: remove notice of dashes in V8 options 2018-10-29 21:24:08 +00:00
dns.md doc: add missing metadata for dns.lookup 2018-09-19 21:11:51 +02:00
documentation.md doc: use Node.js instead of Node 2018-10-31 23:26:51 -07:00
domain.md doc: remove notice of dashes in V8 options 2018-10-29 21:24:08 +00:00
errors.md doc: clarify allowed encoding parameter types 2018-11-09 15:57:17 -08:00
esm.md esm: provide named exports for builtin libs 2018-05-11 12:06:18 -05:00
events.md doc: add note about removeListener order 2018-10-23 13:12:03 -07:00
fs.md doc: clarify fd behaviour with {read,write}File 2018-10-31 19:30:41 +05:30
globals.md doc: remove "idiomatic choice" from queueMicrotask 2018-10-31 07:38:30 +11:00
http2.md http2: add Http2Stream.bufferSize 2018-11-05 22:00:35 -08:00
http.md doc: add documentation for http.IncomingMessage$complete 2018-10-30 08:47:31 -07:00
https.md doc: add types and their corresponding return values 2018-11-02 00:36:40 +02:00
index.md doc: remove mailing list 2018-10-29 20:49:59 -07:00
inspector.md doc: inspector security warning for changing host 2018-11-05 22:38:01 -08:00
intl.md doc: bump ICU version to avoid confusion 2018-08-14 22:44:58 +03:00
modules.md doc: use Node.js instead of Node 2018-10-31 23:26:51 -07:00
n-api.md benchmark,doc,lib,src,test,tools: fix typos 2018-10-09 16:53:12 +03:00
net.md doc: add missing comma in net documentation 2018-11-04 11:58:28 +01:00
os.md doc, win: improve os.setPriority documentation 2018-09-19 08:02:18 +02:00
path.md doc: implement minor text fixes to path.md 2018-11-05 23:21:45 -08:00
perf_hooks.md perf_hooks: remove less useful bootstrap marks 2018-06-15 09:05:19 -07:00
process.md timers: run nextTicks after each immediate and timer 2018-10-17 20:38:07 -07: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 lib: add escapeCodeTimeout as an option to createInterface 2018-10-25 15:19:02 -07:00
repl.md doc: add types and their corresponding return values 2018-11-02 00:36:40 +02:00
stream.md doc: fix minor text issues in stream.md 2018-11-05 22:26:44 -08:00
string_decoder.md string_decoder: support typed array or data view 2018-09-17 17:48:44 +02:00
synopsis.md doc: fix typographical issues 2018-10-31 01:14:37 +02:00
timers.md 2018-10-23, Version 11.0.0 (Current) 2018-10-23 11:03:02 -07:00
tls.md doc: add types and their corresponding return values 2018-11-02 00:36:40 +02:00
tracing.md trace_events: forbid tracing modifications from worker threads 2018-10-24 11:20:35 -03:00
tty.md tty: document WriteStream.cursorTo() and others 2018-10-06 01:36:03 +03:00
url.md 2018-10-23, Version 11.0.0 (Current) 2018-10-23 11:03:02 -07:00
util.md 2018-10-23, Version 11.0.0 (Current) 2018-10-23 11:03:02 -07:00
v8.md lib: enable TypedArray and DataView for the v8 module 2018-10-31 10:41:41 -04:00
vm.md vm: clarify timeout option in vm 2018-11-05 22:39:01 -08:00
worker_threads.md trace_events: forbid tracing modifications from worker threads 2018-10-24 11:20:35 -03:00
zlib.md doc: unify optional arguments format in headings 2018-08-19 21:45:39 +03:00