Skip to content

Commit 8ad63ec

Browse files
committed
doc: fix more type case inconsistencies
1 parent 9772fb9 commit 8ad63ec

20 files changed

+410
-409
lines changed

doc/api/assert.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,7 @@ added: v0.1.21
248248
* `actual` {any}
249249
* `expected` {any}
250250
* `message` {any}
251-
* `operator` {String}
251+
* `operator` {string}
252252

253253
Throws an `AssertionError`. If `message` is falsy, the error message is set as
254254
the values of `actual` and `expected` separated by the provided `operator`.

doc/api/buffer.md

Lines changed: 102 additions & 102 deletions
Large diffs are not rendered by default.

doc/api/child_process.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -135,9 +135,9 @@ added: v0.1.90
135135
understand the `-c` switch on UNIX or `/d /s /c` on Windows. On Windows,
136136
command line parsing should be compatible with `cmd.exe`.)
137137
* `timeout` {number} (Default: `0`)
138-
* [`maxBuffer`][] {Number} largest amount of data (in bytes) allowed on
138+
* [`maxBuffer`][] {number} largest amount of data (in bytes) allowed on
139139
stdout or stderr - if exceeded child process is killed (Default: `200*1024`)
140-
* `killSignal` {string|Integer} (Default: `'SIGTERM'`)
140+
* `killSignal` {string|integer} (Default: `'SIGTERM'`)
141141
* `uid` {number} Sets the user identity of the process. (See setuid(2).)
142142
* `gid` {number} Sets the group identity of the process. (See setgid(2).)
143143
* `callback` {Function} called with the output when process terminates
@@ -212,9 +212,9 @@ added: v0.1.91
212212
* `env` {Object} Environment key-value pairs
213213
* `encoding` {string} (Default: `'utf8'`)
214214
* `timeout` {number} (Default: `0`)
215-
* [`maxBuffer`][] {Number} largest amount of data (in bytes) allowed on
215+
* [`maxBuffer`][] {number} largest amount of data (in bytes) allowed on
216216
stdout or stderr - if exceeded child process is killed (Default: `200*1024`)
217-
* `killSignal` {string|Integer} (Default: `'SIGTERM'`)
217+
* `killSignal` {string|integer} (Default: `'SIGTERM'`)
218218
* `uid` {number} Sets the user identity of the process. (See setuid(2).)
219219
* `gid` {number} Sets the group identity of the process. (See setgid(2).)
220220
* `callback` {Function} called with the output when process terminates
@@ -608,17 +608,17 @@ changes:
608608
* `input` {string|Buffer|Uint8Array} The value which will be passed as stdin
609609
to the spawned process
610610
- supplying this value will override `stdio[0]`
611-
* `stdio` {string | Array} Child's stdio configuration. (Default: `'pipe'`)
611+
* `stdio` {string|Array} Child's stdio configuration. (Default: `'pipe'`)
612612
- `stderr` by default will be output to the parent process' stderr unless
613613
`stdio` is specified
614614
* `env` {Object} Environment key-value pairs
615615
* `uid` {number} Sets the user identity of the process. (See setuid(2).)
616616
* `gid` {number} Sets the group identity of the process. (See setgid(2).)
617617
* `timeout` {number} In milliseconds the maximum amount of time the process
618618
is allowed to run. (Default: `undefined`)
619-
* `killSignal` {string|Integer} The signal value to be used when the spawned
619+
* `killSignal` {string|integer} The signal value to be used when the spawned
620620
process will be killed. (Default: `'SIGTERM'`)
621-
* [`maxBuffer`][] {Number} largest amount of data (in bytes) allowed on
621+
* [`maxBuffer`][] {number} largest amount of data (in bytes) allowed on
622622
stdout or stderr - if exceeded child process is killed
623623
* `encoding` {string} The encoding used for all stdio inputs and outputs. (Default: `'buffer'`)
624624
* Returns: {Buffer|string} The stdout from the command
@@ -650,7 +650,7 @@ changes:
650650
* `input` {string|Buffer|Uint8Array} The value which will be passed as stdin
651651
to the spawned process
652652
- supplying this value will override `stdio[0]`
653-
* `stdio` {string | Array} Child's stdio configuration. (Default: `'pipe'`)
653+
* `stdio` {string|Array} Child's stdio configuration. (Default: `'pipe'`)
654654
- `stderr` by default will be output to the parent process' stderr unless
655655
`stdio` is specified
656656
* `env` {Object} Environment key-value pairs
@@ -662,9 +662,9 @@ changes:
662662
* `gid` {number} Sets the group identity of the process. (See setgid(2).)
663663
* `timeout` {number} In milliseconds the maximum amount of time the process
664664
is allowed to run. (Default: `undefined`)
665-
* `killSignal` {string|Integer} The signal value to be used when the spawned
665+
* `killSignal` {string|integer} The signal value to be used when the spawned
666666
process will be killed. (Default: `'SIGTERM'`)
667-
* [`maxBuffer`][] {Number} largest amount of data (in bytes) allowed on
667+
* [`maxBuffer`][] {number} largest amount of data (in bytes) allowed on
668668
stdout or stderr - if exceeded child process is killed
669669
* `encoding` {string} The encoding used for all stdio inputs and outputs.
670670
(Default: `'buffer'`)
@@ -708,15 +708,15 @@ changes:
708708
* `input` {string|Buffer|Uint8Array} The value which will be passed as stdin
709709
to the spawned process
710710
- supplying this value will override `stdio[0]`
711-
* `stdio` {string | Array} Child's stdio configuration.
711+
* `stdio` {string|Array} Child's stdio configuration.
712712
* `env` {Object} Environment key-value pairs
713713
* `uid` {number} Sets the user identity of the process. (See setuid(2).)
714714
* `gid` {number} Sets the group identity of the process. (See setgid(2).)
715715
* `timeout` {number} In milliseconds the maximum amount of time the process
716716
is allowed to run. (Default: `undefined`)
717-
* `killSignal` {string|Integer} The signal value to be used when the spawned
717+
* `killSignal` {string|integer} The signal value to be used when the spawned
718718
process will be killed. (Default: `'SIGTERM'`)
719-
* [`maxBuffer`][] {Number} largest amount of data (in bytes) allowed on
719+
* [`maxBuffer`][] {number} largest amount of data (in bytes) allowed on
720720
stdout or stderr - if exceeded child process is killed
721721
* `encoding` {string} The encoding used for all stdio inputs and outputs.
722722
(Default: `'buffer'`)
@@ -846,7 +846,7 @@ IPC channel currently exists, this property is `undefined`.
846846
added: v0.7.2
847847
-->
848848

849-
* {Boolean} Set to `false` after `child.disconnect()` is called
849+
* {boolean} Set to `false` after `child.disconnect()` is called
850850

851851
The `child.connected` property indicates whether it is still possible to send
852852
and receive messages from a child process. When `child.connected` is `false`, it
@@ -933,7 +933,7 @@ setTimeout(() => {
933933
added: v0.1.90
934934
-->
935935

936-
* {Number} Integer
936+
* {number} Integer
937937

938938
Returns the process identifier (PID) of the child process.
939939

@@ -967,7 +967,7 @@ changes:
967967
* `sendHandle` {Handle}
968968
* `options` {Object}
969969
* `callback` {Function}
970-
* Returns: {Boolean}
970+
* Returns: {boolean}
971971

972972
When an IPC channel has been established between the parent and child (
973973
i.e. when using [`child_process.fork()`][]), the `child.send()` method can be

doc/api/cluster.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -332,7 +332,7 @@ if (cluster.isMaster) {
332332
added: v6.0.0
333333
-->
334334

335-
* {Boolean}
335+
* {boolean}
336336

337337
Set by calling `.kill()` or `.disconnect()`. Until then, it is `undefined`.
338338

@@ -356,7 +356,7 @@ worker.kill();
356356
added: v0.8.0
357357
-->
358358

359-
* {Number}
359+
* {number}
360360

361361
Each new worker is given its own unique id, this id is stored in the
362362
`id`.
@@ -691,7 +691,7 @@ This can only be called from the master process.
691691
added: v0.8.1
692692
-->
693693

694-
* {Boolean}
694+
* {boolean}
695695

696696
True if the process is a master. This is determined
697697
by the `process.env.NODE_UNIQUE_ID`. If `process.env.NODE_UNIQUE_ID` is
@@ -702,7 +702,7 @@ undefined, then `isMaster` is `true`.
702702
added: v0.6.0
703703
-->
704704

705-
* {Boolean}
705+
* {boolean}
706706

707707
True if the process is not a master (it is the negation of `cluster.isMaster`).
708708

doc/api/console.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -169,9 +169,9 @@ added: v0.1.101
169169
-->
170170
* `obj` {any}
171171
* `options` {Object}
172-
* `showHidden` {Boolean}
173-
* `depth` {Number}
174-
* `colors` {Boolean}
172+
* `showHidden` {boolean}
173+
* `depth` {number}
174+
* `colors` {boolean}
175175

176176
Uses [`util.inspect()`][] on `obj` and prints the resulting string to `stdout`.
177177
This function bypasses any custom `inspect()` function defined on `obj`. An
@@ -250,7 +250,7 @@ values are concatenated. See [`util.format()`][] for more information.
250250
<!-- YAML
251251
added: v0.1.104
252252
-->
253-
* `label` {String}
253+
* `label` {string}
254254

255255
Starts a timer that can be used to compute the duration of an operation. Timers
256256
are identified by a unique `label`. Use the same `label` when you call
@@ -266,7 +266,7 @@ changes:
266266
description: This method no longer supports multiple calls that don’t map
267267
to individual `console.time()` calls; see below for details.
268268
-->
269-
* `label` {String}
269+
* `label` {string}
270270

271271
Stops a timer that was previously started by calling [`console.time()`][] and
272272
prints the result to `stdout`:

doc/api/crypto.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -937,8 +937,8 @@ The `private_key` argument can be an object or a string. If `private_key` is a
937937
string, it is treated as a raw key with no passphrase. If `private_key` is an
938938
object, it is interpreted as a hash containing two properties:
939939

940-
* `key` : {String} - PEM encoded private key
941-
* `passphrase` : {String} - passphrase for the private key
940+
* `key`: {string} - PEM encoded private key
941+
* `passphrase`: {string} - passphrase for the private key
942942

943943
The `output_format` can specify one of `'latin1'`, `'hex'` or `'base64'`. If
944944
`output_format` is provided a string is returned; otherwise a [`Buffer`][] is
@@ -1480,8 +1480,8 @@ treated as the key with no passphrase and will use `RSA_PKCS1_OAEP_PADDING`.
14801480
If `private_key` is an object, it is interpreted as a hash object with the
14811481
keys:
14821482

1483-
* `key` : {String} - PEM encoded private key
1484-
* `passphrase` : {String} - Optional passphrase for the private key
1483+
* `key`: {string} - PEM encoded private key
1484+
* `passphrase`: {string} - Optional passphrase for the private key
14851485
* `padding` : An optional padding value, one of the following:
14861486
* `crypto.constants.RSA_NO_PADDING`
14871487
* `crypto.constants.RSA_PKCS1_PADDING`
@@ -1501,8 +1501,8 @@ treated as the key with no passphrase and will use `RSA_PKCS1_PADDING`.
15011501
If `private_key` is an object, it is interpreted as a hash object with the
15021502
keys:
15031503

1504-
* `key` : {String} - PEM encoded private key
1505-
* `passphrase` : {String} - Optional passphrase for the private key
1504+
* `key`: {string} - PEM encoded private key
1505+
* `passphrase`: {string} - Optional passphrase for the private key
15061506
* `padding` : An optional padding value, one of the following:
15071507
* `crypto.constants.RSA_NO_PADDING`
15081508
* `crypto.constants.RSA_PKCS1_PADDING`
@@ -1521,8 +1521,8 @@ treated as the key with no passphrase and will use `RSA_PKCS1_PADDING`.
15211521
If `public_key` is an object, it is interpreted as a hash object with the
15221522
keys:
15231523

1524-
* `key` : {String} - PEM encoded public key
1525-
* `passphrase` : {String} - Optional passphrase for the private key
1524+
* `key`: {string} - PEM encoded public key
1525+
* `passphrase`: {string} - Optional passphrase for the private key
15261526
* `padding` : An optional padding value, one of the following:
15271527
* `crypto.constants.RSA_NO_PADDING`
15281528
* `crypto.constants.RSA_PKCS1_PADDING`
@@ -1545,8 +1545,8 @@ treated as the key with no passphrase and will use `RSA_PKCS1_OAEP_PADDING`.
15451545
If `public_key` is an object, it is interpreted as a hash object with the
15461546
keys:
15471547

1548-
* `key` : {String} - PEM encoded public key
1549-
* `passphrase` : {String} - Optional passphrase for the private key
1548+
* `key`: {string} - PEM encoded public key
1549+
* `passphrase`: {string} - Optional passphrase for the private key
15501550
* `padding` : An optional padding value, one of the following:
15511551
* `crypto.constants.RSA_NO_PADDING`
15521552
* `crypto.constants.RSA_PKCS1_PADDING`

doc/api/dns.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,13 +80,13 @@ Alternatively, `options` can be an object containing these properties:
8080

8181
* `family` {number} - The record family. If present, must be the integer
8282
`4` or `6`. If not provided, both IP v4 and v6 addresses are accepted.
83-
* `hints`: {Number} - If present, it should be one or more of the supported
83+
* `hints`: {number} - If present, it should be one or more of the supported
8484
`getaddrinfo` flags. If `hints` is not provided, then no flags are passed to
8585
`getaddrinfo`. Multiple flags can be passed through `hints` by bitwise
8686
`OR`ing their values.
8787
See [supported `getaddrinfo` flags][] for more information on supported
8888
flags.
89-
* `all`: {Boolean} - When `true`, the callback returns all resolved addresses
89+
* `all`: {boolean} - When `true`, the callback returns all resolved addresses
9090
in an array, otherwise returns a single address. Defaults to `false`.
9191

9292
All properties are optional.

doc/api/errors.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ new MyError().stack;
243243

244244
### Error.stackTraceLimit
245245

246-
* {Number}
246+
* {number}
247247

248248
The `Error.stackTraceLimit` property specifies the number of stack frames
249249
collected by a stack trace (whether generated by `new Error().stack` or
@@ -257,7 +257,7 @@ not capture any frames.
257257

258258
### error.message
259259

260-
* {String}
260+
* {string}
261261

262262
The `error.message` property is the string description of the error as set by calling `new Error(message)`.
263263
The `message` passed to the constructor will also appear in the first line of
@@ -273,7 +273,7 @@ console.error(err.message);
273273

274274
### error.stack
275275

276-
* {String}
276+
* {string}
277277

278278
The `error.stack` property is a string describing the point in the code at which
279279
the `Error` was instantiated.
@@ -449,14 +449,14 @@ added properties.
449449

450450
#### error.code
451451

452-
* {String}
452+
* {string}
453453

454454
The `error.code` property is a string representing the error code, which is always
455455
`E` followed by a sequence of capital letters.
456456

457457
#### error.errno
458458

459-
* {String | Number}
459+
* {string|number}
460460

461461
The `error.errno` property is a number or a string.
462462
The number is a **negative** value which corresponds to the error code defined in
@@ -466,27 +466,27 @@ In case of a string, it is the same as `error.code`.
466466

467467
#### error.syscall
468468

469-
* {String}
469+
* {string}
470470

471471
The `error.syscall` property is a string describing the [syscall][] that failed.
472472

473473
#### error.path
474474

475-
* {String}
475+
* {string}
476476

477477
When present (e.g. in `fs` or `child_process`), the `error.path` property is a string
478478
containing a relevant invalid pathname.
479479

480480
#### error.address
481481

482-
* {String}
482+
* {string}
483483

484484
When present (e.g. in `net` or `dgram`), the `error.address` property is a string
485485
describing the address to which the connection failed.
486486

487487
#### error.port
488488

489-
* {Number}
489+
* {number}
490490

491491
When present (e.g. in `net` or `dgram`), the `error.port` property is a number representing
492492
the connection's port that is not available.

0 commit comments

Comments
 (0)