Michael Dawson ea65e1f6bb node-api,doc: document parms which can be optional ...

Fixes: https://github.com/nodejs/abi-stable-node/issues/252

I've been through the Node-api methods and I believe
this is the last places where optional parameters
were not documented.

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: https://github.com/nodejs/node/pull/41021
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>

2021-12-03 16:19:00 -05:00

..

addons.md

doc: format doc/api/*.md with markdown formatter

2021-10-20 11:59:11 +02:00

assert.md

assert,util: compare RegExp.lastIndex while using deep equal checks

2021-12-02 08:01:40 +00:00

async_context.md

doc: improve async_context introduction

2021-10-24 12:36:03 +00:00

async_hooks.md

2021-11-30, Version 17.2.0 (Current)

2021-11-30 18:45:03 +01:00

buffer.md

doc: format doc/api/*.md with markdown formatter

2021-10-20 11:59:11 +02:00

child_process.md

tools: avoid unnecessary escaping in markdown formatter

2021-10-31 09:36:05 -07:00

cli.md

doc: remove experimental abortcontroller flag

2021-11-25 11:59:47 -08:00

cluster.md

doc: format doc/api/*.md with markdown formatter

2021-10-20 11:59:11 +02:00

console.md

doc: format doc/api/*.md with markdown formatter

2021-10-20 11:59:11 +02:00

corepack.md

doc: fix corepack grammar for --force flag

2021-11-09 18:12:48 +01:00

crypto.md

2021-11-30, Version 17.2.0 (Current)

2021-11-30 18:45:03 +01:00

debugger.md

doc: add information on suppressing initial break in debugger

2021-11-26 08:58:39 +00:00

deprecations.md

2021-11-30, Version 17.2.0 (Current)

2021-11-30 18:45:03 +01:00

dgram.md

doc: format doc/api/*.md with markdown formatter

2021-10-20 11:59:11 +02:00

diagnostics_channel.md

2021-11-09, Version 17.1.0 (Current)

2021-11-09 20:06:12 +01:00

dns.md

doc: fix markdown syntax and HTML tag misses

2021-10-28 09:22:57 -07:00

documentation.md

doc: format doc/api/*.md with markdown formatter

2021-10-20 11:59:11 +02:00

domain.md

doc: format doc/api/*.md with markdown formatter

2021-10-20 11:59:11 +02:00

embedding.md

doc: format doc/api/*.md with markdown formatter

2021-10-20 11:59:11 +02:00

errors.md

2021-11-09, Version 17.1.0 (Current)

2021-11-09 20:06:12 +01:00

esm.md

esm: working mock test

2021-11-29 14:54:01 -06:00

events.md

doc: format doc/api/*.md with markdown formatter

2021-10-20 11:59:11 +02:00

fs.md

doc: fix fs.symlink code example

2021-10-23 00:44:59 +02:00

globals.md

lib: add AbortSignal.timeout

2021-12-01 16:26:24 -08:00

http2.md

doc: format doc/api/*.md with markdown formatter

2021-10-20 11:59:11 +02:00

http.md

doc: specify that message.socket can be nulled

2021-12-01 19:47:20 +00:00

https.md

doc: format doc/api/*.md with markdown formatter

2021-10-20 11:59:11 +02:00

index.md

tools: avoid unnecessary escaping in markdown formatter

2021-10-31 09:36:05 -07:00

inspector.md

doc: format doc/api/*.md with markdown formatter

2021-10-20 11:59:11 +02:00

intl.md

doc: format doc/api/*.md with markdown formatter

2021-10-20 11:59:11 +02:00

module.md

doc: format doc/api/*.md with markdown formatter

2021-10-20 11:59:11 +02:00

modules.md

tools: avoid unnecessary escaping in markdown formatter

2021-10-31 09:36:05 -07:00

n-api.md

node-api,doc: document parms which can be optional

2021-12-03 16:19:00 -05:00

net.md

doc: expand entries for isIP(), isIPv4(), and isIPv6()

2021-12-02 21:22:48 +00:00

os.md

doc: fix markdown syntax and HTML tag misses

2021-10-28 09:22:57 -07:00

packages.md

doc: define "types", "deno" community conditions

2021-11-20 16:41:06 -08:00

path.md

doc: format doc/api/*.md with markdown formatter

2021-10-20 11:59:11 +02:00

perf_hooks.md

doc: format doc/api/*.md with markdown formatter

2021-10-20 11:59:11 +02:00

policy.md

doc: add blank line between comments

2021-09-21 18:40:04 -07:00

process.md

tools: avoid unnecessary escaping in markdown formatter

2021-10-31 09:36:05 -07:00

punycode.md

doc: format doc/api/*.md with markdown formatter

2021-10-20 11:59:11 +02:00

querystring.md

doc: format doc/api/*.md with markdown formatter

2021-10-20 11:59:11 +02:00

readline.md

doc: format doc/api/*.md with markdown formatter

2021-10-20 11:59:11 +02:00

repl.md

doc: format doc/api/*.md with markdown formatter

2021-10-20 11:59:11 +02:00

report.md

doc: format doc/api/*.md with markdown formatter

2021-10-20 11:59:11 +02:00

stream.md

stream: unify writableErrored and readableErrored

2021-11-18 14:31:43 +01:00

string_decoder.md

doc: format doc/api/*.md with markdown formatter

2021-10-20 11:59:11 +02:00

synopsis.md

doc: format doc/api/*.md with markdown formatter

2021-10-20 11:59:11 +02:00

timers.md

doc: format doc/api/*.md with markdown formatter

2021-10-20 11:59:11 +02:00

tls.md

2021-11-30, Version 17.2.0 (Current)

2021-11-30 18:45:03 +01:00

tracing.md

doc: format doc/api/*.md with markdown formatter

2021-10-20 11:59:11 +02:00

tty.md

doc: format doc/api/*.md with markdown formatter

2021-10-20 11:59:11 +02:00

url.md

doc: format doc/api/*.md with markdown formatter

2021-10-20 11:59:11 +02:00

util.md

util: add numericSeparator to util.inspect

2021-12-03 14:56:43 +00:00

v8.md

2021-11-09, Version 17.1.0 (Current)

2021-11-09 20:06:12 +01:00

vm.md

2021-10-20, Version 16.12.0 (Current)

2021-10-20 10:40:02 -04:00

wasi.md

doc: format doc/api/*.md with markdown formatter

2021-10-20 11:59:11 +02:00

webcrypto.md

doc: use GFM footnotes in webcrypto.md

2021-10-23 06:13:21 -07:00

webstreams.md

doc: format doc/api/*.md with markdown formatter

2021-10-20 11:59:11 +02:00

worker_threads.md

doc: format doc/api/*.md with markdown formatter

2021-10-20 11:59:11 +02:00

zlib.md

doc: format doc/api/*.md with markdown formatter

2021-10-20 11:59:11 +02:00