0
0
mirror of https://github.com/nodejs/node.git synced 2024-12-01 16:10:02 +01:00
nodejs/doc/api
Ruben Bridgewater 0f900405e5 doc: update assert's validation functions
Using `assert.throws()` or `assert.rejects()` in combination with
validation function can be very powerful. Using them by returning
any value besides `true` makes debugging very difficult though
because there's no context or reason why the error validation failed.
Thus, it is recommended to throw an error in such cases instead of
returning anything besides `true`.

PR-URL: https://github.com/nodejs/node/pull/27781
Reviewed-By: Rich Trott <rtrott@gmail.com>
2019-06-12 20:02:53 -07:00
..
addons.md doc: hello addon example should return "world" 2019-03-05 23:54:31 +01:00
assert.md doc: update assert's validation functions 2019-06-12 20:02:53 -07:00
async_hooks.md src: do not reuse async resource in http parsers 2019-04-22 11:51:46 -07:00
buffer.md doc: add Buffer#subarray() and add note about Uint8Array#slice() 2019-06-12 19:40:37 -07:00
child_process.md doc: correct parameter type on 'subprocess.kill([signal])' 2019-05-20 23:00:31 +08:00
cli.md doc: add tls-min/max options to NODE_OPTIONS 2019-06-12 12:24:16 -07:00
cluster.md benchmark,doc,lib: capitalize more comments 2019-03-27 17:20:06 +01:00
console.md benchmark,doc,lib: capitalize more comments 2019-03-27 17:20:06 +01:00
crypto.md doc: clarify weak keys text 2019-06-08 18:16:08 -07: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: edit reason-for-deprecation text 2019-06-08 18:58:23 -07:00
dgram.md 2019-04-23, Version 12.0.0 (Current) 2019-04-23 16:46:54 +01:00
dns.md doc: dns.lookup() documentation error code 2019-05-13 16:57:07 -07:00
documentation.md doc: simplify system call material in doc overview 2019-06-02 00:10:01 +02:00
domain.md benchmark,doc,lib: capitalize more comments 2019-03-27 17:20:06 +01:00
errors.md worker: use DataCloneError for unknown native objects 2019-06-10 15:22:54 +02:00
esm.md doc: add current recommendation for ESM/CommonJS dual packages 2019-06-10 22:32:48 -07:00
events.md 2019-03-28, Version 11.13.0 (Current) 2019-03-28 20:23:29 +01:00
fs.md doc: remove "encouraged" as hedging in fs.md 2019-06-05 23:18:27 +08:00
globals.md lib: move queueMicrotask to stable 2019-03-08 08:19:38 -06:00
http2.md doc: document Http2Stream#id property 2019-06-10 17:02:41 -07:00
http.md http, http2: remove default server timeout 2019-05-09 08:54:04 -07:00
https.md http: servername === false should disable SNI 2019-04-30 06:43:22 -07:00
index.md doc: add node-report documentation 2019-01-18 10:35:55 +05:30
inspector.md doc: add inspector API example for heapdump 2019-03-11 06:19:11 +01:00
intl.md doc: sort bottom-of-file markdown links 2018-11-28 13:09:31 -08:00
modules.md doc: clarify wording in modules.md 2019-06-02 11:57:01 +02:00
n-api.md doc: clarify N-API version Matrix 2019-06-11 09:19:39 -04:00
net.md benchmark,doc,lib,test: capitalize comments 2019-03-10 00:44:40 +01:00
os.md doc: fix section sorting, add link reference 2019-04-03 22:44:53 +03:00
path.md doc: fix extname with the correct description 2019-04-20 17:01:09 +03:00
perf_hooks.md benchmark,doc,lib,test: capitalize comments 2019-03-10 00:44:40 +01:00
policy.md doc: fix metadata for v11.8.0 doc changes 2019-01-25 19:09:26 -08:00
process.md 2019-04-23, Version 12.0.0 (Current) 2019-04-23 16:46:54 +01:00
punycode.md doc: prevent some redirections 2018-07-14 22:57:03 +03:00
querystring.md benchmark,doc,lib: capitalize more comments 2019-03-27 17:20:06 +01:00
readline.md 2019-04-11, Version 11.14.0 (Current) 2019-04-11 17:56:55 +01:00
repl.md 2019-05-21, Version 12.3.0 (Current) 2019-05-21 21:23:52 +02:00
report.md report: print common items first for readability 2019-04-27 12:04:36 +02:00
stream.md stream: convert string to Buffer when calling unshift(<string>) 2019-06-02 16:56:13 +02:00
string_decoder.md string_decoder: support typed array or data view 2018-09-17 17:48:44 +02:00
synopsis.md doc: improve synopsis.md 2019-06-09 09:20:25 -07:00
timers.md benchmark,doc,lib: capitalize more comments 2019-03-27 17:20:06 +01:00
tls.md doc: remove "strongly recommended" hedging from tls.md 2019-06-05 23:11:28 +08:00
tracing.md doc: document trace-events category for dns requests 2019-06-12 19:42:54 -07:00
tty.md doc: specify return type for tty.isatty() 2019-04-09 23:06:46 +03:00
url.md doc: clarify special schemes 2019-06-08 18:51:41 -07:00
util.md util: include reference anchor for circular structures 2019-05-20 14:20:59 +02:00
v8.md src: export number_of_native_contexts and number_of_detached_contexts 2019-05-30 15:25:55 +02:00
vm.md doc: fix section order in vm.md 2019-01-14 09:36:41 +01:00
worker_threads.md doc: add note about AsyncResource for Worker pooling 2019-06-10 15:20:54 +02:00
zlib.md benchmark,doc,lib: capitalize more comments 2019-03-27 17:20:06 +01:00