lukechilds
/
node
mirror of https://github.com/lukechilds/node.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

doc: consistent case for primitive types 

PR-URL: https://github.com/nodejs/node/pull/11167
Backport-PR-URL: https://github.com/nodejs/node/pull/13054
Reviewed-By: Timothy Gu <timothygu99@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
v6.x
Roman Reiss 8 years ago
committed by Myles Borins
parent
890e210a5f
commit
dd1fb98bda
No known key found for this signature in database GPG Key ID: 933B01F40B5CA946
21 changed files with 515 additions and 434 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 117
      doc/api/buffer.md
  2. 148
      doc/api/child_process.md
  3. 22
      doc/api/cluster.md
  4. 46
      doc/api/dgram.md
  5. 10
      doc/api/dns.md
  6. 2
      doc/api/errors.md
  7. 14
      doc/api/events.md
  8. 232
      doc/api/fs.md
  9. 84
      doc/api/http.md
  10. 2
      doc/api/modules.md
  11. 26
      doc/api/net.md
  12. 12
      doc/api/os.md
  13. 42
      doc/api/path.md
  14. 32
      doc/api/process.md
  15. 10
      doc/api/punycode.md
  16. 14
      doc/api/querystring.md
  17. 10
      doc/api/readline.md
  18. 8
      doc/api/repl.md
  19. 54
      doc/api/stream.md
  20. 54
      doc/api/url.md
  21. 10
      doc/api/util.md

117
doc/api/buffer.md
View File

@ -424,8 +424,8 @@ deprecated: v6.0.0
> Stability: 0 - Deprecated: > Stability: 0 - Deprecated:
> Use [`Buffer.from(string[, encoding])`][`Buffer.from(string)`] instead. > Use [`Buffer.from(string[, encoding])`][`Buffer.from(string)`] instead.
* `string` {String} String to encode * `string` {string} String to encode
* `encoding` {String} The encoding of `string`. **Default:** `'utf8'` * `encoding` {string} The encoding of `string`. **Default:** `'utf8'`
Creates a new `Buffer` containing the given JavaScript string `string`. If Creates a new `Buffer` containing the given JavaScript string `string`. If
provided, the `encoding` parameter identifies the character encoding of `string`. provided, the `encoding` parameter identifies the character encoding of `string`.
@ -454,9 +454,9 @@ added: v5.10.0
--> -->
* `size` {Integer} The desired length of the new `Buffer` * `size` {Integer} The desired length of the new `Buffer`
* `fill` {String | Buffer | Integer} A value to pre-fill the new `Buffer` with. * `fill` {string | Buffer | Integer} A value to pre-fill the new `Buffer` with.
**Default:** `0` **Default:** `0`
* `encoding` {String} If `fill` is a string, this is its encoding. * `encoding` {string} If `fill` is a string, this is its encoding.
**Default:** `'utf8'` **Default:** `'utf8'`
Allocates a new `Buffer` of `size` bytes. If `fill` is `undefined`, the Allocates a new `Buffer` of `size` bytes. If `fill` is `undefined`, the
@ -609,9 +609,9 @@ A `TypeError` will be thrown if `size` is not a number.
added: v0.1.90 added: v0.1.90
--> -->
* `string` {String | Buffer | TypedArray | DataView | ArrayBuffer} A value to * `string` {string | Buffer | TypedArray | DataView | ArrayBuffer} A value to
calculate the length of calculate the length of
* `encoding` {String} If `string` is a string, this is its encoding. * `encoding` {string} If `string` is a string, this is its encoding.
**Default:** `'utf8'` **Default:** `'utf8'`
* Returns: {Integer} The number of bytes contained within `string` * Returns: {Integer} The number of bytes contained within `string`
@ -805,8 +805,8 @@ A `TypeError` will be thrown if `buffer` is not a `Buffer`.
added: v5.10.0 added: v5.10.0
--> -->
* `string` {String} A string to encode. * `string` {string} A string to encode.
* `encoding` {String} The encoding of `string`. **Default:** `'utf8'` * `encoding` {string} The encoding of `string`. **Default:** `'utf8'`
Creates a new `Buffer` containing the given JavaScript string `string`. If Creates a new `Buffer` containing the given JavaScript string `string`. If
provided, the `encoding` parameter identifies the character encoding of `string`. provided, the `encoding` parameter identifies the character encoding of `string`.
@ -846,7 +846,7 @@ Returns `true` if `obj` is a `Buffer`, `false` otherwise.
added: v0.9.1 added: v0.9.1
--> -->
* `encoding` {String} A character encoding name to check * `encoding` {string} A character encoding name to check
* Returns: {Boolean} * Returns: {Boolean}
Returns `true` if `encoding` contains a supported character encoding, or `false` Returns `true` if `encoding` contains a supported character encoding, or `false`
@ -1075,10 +1075,10 @@ console.log(buf1.equals(buf3));
added: v0.5.0 added: v0.5.0
--> -->
* `value` {String | Buffer | Integer} The value to fill `buf` with * `value` {string | Buffer | Integer} The value to fill `buf` with
* `offset` {Integer} Where to start filling `buf`. **Default:** `0` * `offset` {Integer} Where to start filling `buf`. **Default:** `0`
* `end` {Integer} Where to stop filling `buf` (not inclusive). **Default:** [`buf.length`] * `end` {Integer} Where to stop filling `buf` (not inclusive). **Default:** [`buf.length`]
* `encoding` {String} If `value` is a string, this is its encoding. * `encoding` {string} If `value` is a string, this is its encoding.
**Default:** `'utf8'` **Default:** `'utf8'`
* Returns: {Buffer} A reference to `buf` * Returns: {Buffer} A reference to `buf`
@ -1107,6 +1107,47 @@ Example: Fill a `Buffer` with a two-byte character
console.log(Buffer.allocUnsafe(3).fill('\u0222')); console.log(Buffer.allocUnsafe(3).fill('\u0222'));
``` ```
### buf.includes(value[, byteOffset][, encoding])
<!-- YAML
added: v5.3.0
-->
* `value` {string | Buffer | Integer} What to search for
* `byteOffset` {Integer} Where to begin searching in `buf`. **Default:** `0`
* `encoding` {string} If `value` is a string, this is its encoding.
**Default:** `'utf8'`
* Returns: {Boolean} `true` if `value` was found in `buf`, `false` otherwise
Equivalent to [`buf.indexOf() !== -1`][`buf.indexOf()`].
Examples:
```js
const buf = Buffer.from('this is a buffer');
// Prints: true
console.log(buf.includes('this'));
// Prints: true
console.log(buf.includes('is'));
// Prints: true
console.log(buf.includes(Buffer.from('a buffer')));
// Prints: true
// (97 is the decimal ASCII value for 'a')
console.log(buf.includes(97));
// Prints: false
console.log(buf.includes(Buffer.from('a buffer example')));
// Prints: true
console.log(buf.includes(Buffer.from('a buffer example').slice(0, 8)));
// Prints: false
console.log(buf.includes('this', 4));
```
### buf.indexOf(value[, byteOffset][, encoding]) ### buf.indexOf(value[, byteOffset][, encoding])
<!-- YAML <!-- YAML
added: v1.5.0 added: v1.5.0
@ -1114,7 +1155,7 @@ added: v1.5.0
* `value` {String | Buffer | Integer} What to search for * `value` {String | Buffer | Integer} What to search for
* `byteOffset` {Integer} Where to begin searching in `buf`. **Default:** `0` * `byteOffset` {Integer} Where to begin searching in `buf`. **Default:** `0`
* `encoding` {String} If `value` is a string, this is its encoding. * `encoding` {string} If `value` is a string, this is its encoding.
**Default:** `'utf8'` **Default:** `'utf8'`
* Returns: {Integer} The index of the first occurrence of `value` in `buf` or `-1` * Returns: {Integer} The index of the first occurrence of `value` in `buf` or `-1`
if `buf` does not contain `value` if `buf` does not contain `value`
@ -1261,7 +1302,7 @@ added: v6.0.0
* `value` {String | Buffer | Integer} What to search for * `value` {String | Buffer | Integer} What to search for
* `byteOffset` {Integer} Where to begin searching in `buf`. * `byteOffset` {Integer} Where to begin searching in `buf`.
**Default:** [`buf.length`]` - 1` **Default:** [`buf.length`]` - 1`
* `encoding` {String} If `value` is a string, this is its encoding. * `encoding` {string} If `value` is a string, this is its encoding.
**Default:** `'utf8'` **Default:** `'utf8'`
* Returns: {Integer} The index of the last occurrence of `value` in `buf` or `-1` * Returns: {Integer} The index of the last occurrence of `value` in `buf` or `-1`
if `buf` does not contain `value` if `buf` does not contain `value`
@ -1385,7 +1426,7 @@ added: v0.11.15
--> -->
* `offset` {Integer} Where to start reading. Must satisfy: `0 <= offset <= buf.length - 8` * `offset` {Integer} Where to start reading. Must satisfy: `0 <= offset <= buf.length - 8`
* `noAssert` {Boolean} Skip `offset` validation? **Default:** `false` * `noAssert` {boolean} Skip `offset` validation? **Default:** `false`
* Returns: {Number} * Returns: {Number}
Reads a 64-bit double from `buf` at the specified `offset` with specified Reads a 64-bit double from `buf` at the specified `offset` with specified
@ -1421,7 +1462,7 @@ added: v0.11.15
--> -->
* `offset` {Integer} Where to start reading. Must satisfy: `0 <= offset <= buf.length - 4` * `offset` {Integer} Where to start reading. Must satisfy: `0 <= offset <= buf.length - 4`
* `noAssert` {Boolean} Skip `offset` validation? **Default:** `false` * `noAssert` {boolean} Skip `offset` validation? **Default:** `false`
* Returns: {Number} * Returns: {Number}
Reads a 32-bit float from `buf` at the specified `offset` with specified Reads a 32-bit float from `buf` at the specified `offset` with specified
@ -1456,7 +1497,7 @@ added: v0.5.0
--> -->
* `offset` {Integer} Where to start reading. Must satisfy: `0 <= offset <= buf.length - 1` * `offset` {Integer} Where to start reading. Must satisfy: `0 <= offset <= buf.length - 1`
* `noAssert` {Boolean} Skip `offset` validation? **Default:** `false` * `noAssert` {boolean} Skip `offset` validation? **Default:** `false`
* Returns: {Integer} * Returns: {Integer}
Reads a signed 8-bit integer from `buf` at the specified `offset`. Reads a signed 8-bit integer from `buf` at the specified `offset`.
@ -1488,7 +1529,7 @@ added: v0.5.5
--> -->
* `offset` {Integer} Where to start reading. Must satisfy: `0 <= offset <= buf.length - 2` * `offset` {Integer} Where to start reading. Must satisfy: `0 <= offset <= buf.length - 2`
* `noAssert` {Boolean} Skip `offset` validation? **Default:** `false` * `noAssert` {boolean} Skip `offset` validation? **Default:** `false`
* Returns: {Integer} * Returns: {Integer}
Reads a signed 16-bit integer from `buf` at the specified `offset` with Reads a signed 16-bit integer from `buf` at the specified `offset` with
@ -1522,7 +1563,7 @@ added: v0.5.5
--> -->
* `offset` {Integer} Where to start reading. Must satisfy: `0 <= offset <= buf.length - 4` * `offset` {Integer} Where to start reading. Must satisfy: `0 <= offset <= buf.length - 4`
* `noAssert` {Boolean} Skip `offset` validation? **Default:** `false` * `noAssert` {boolean} Skip `offset` validation? **Default:** `false`
* Returns: {Integer} * Returns: {Integer}
Reads a signed 32-bit integer from `buf` at the specified `offset` with Reads a signed 32-bit integer from `buf` at the specified `offset` with
@ -1557,7 +1598,7 @@ added: v0.11.15
* `offset` {Integer} Where to start reading. Must satisfy: `0 <= offset <= buf.length - byteLength` * `offset` {Integer} Where to start reading. Must satisfy: `0 <= offset <= buf.length - byteLength`
* `byteLength` {Integer} How many bytes to read. Must satisfy: `0 < byteLength <= 6` * `byteLength` {Integer} How many bytes to read. Must satisfy: `0 < byteLength <= 6`
* `noAssert` {Boolean} Skip `offset` and `byteLength` validation? **Default:** `false` * `noAssert` {boolean} Skip `offset` and `byteLength` validation? **Default:** `false`
* Returns: {Integer} * Returns: {Integer}
Reads `byteLength` number of bytes from `buf` at the specified `offset` Reads `byteLength` number of bytes from `buf` at the specified `offset`
@ -1588,7 +1629,7 @@ added: v0.5.0
--> -->
* `offset` {Integer} Where to start reading. Must satisfy: `0 <= offset <= buf.length - 1` * `offset` {Integer} Where to start reading. Must satisfy: `0 <= offset <= buf.length - 1`
* `noAssert` {Boolean} Skip `offset` validation? **Default:** `false` * `noAssert` {boolean} Skip `offset` validation? **Default:** `false`
* Returns: {Integer} * Returns: {Integer}
Reads an unsigned 8-bit integer from `buf` at the specified `offset`. Reads an unsigned 8-bit integer from `buf` at the specified `offset`.
@ -1618,7 +1659,7 @@ added: v0.5.5
--> -->
* `offset` {Integer} Where to start reading. Must satisfy: `0 <= offset <= buf.length - 2` * `offset` {Integer} Where to start reading. Must satisfy: `0 <= offset <= buf.length - 2`
* `noAssert` {Boolean} Skip `offset` validation? **Default:** `false` * `noAssert` {boolean} Skip `offset` validation? **Default:** `false`
* Returns: {Integer} * Returns: {Integer}
Reads an unsigned 16-bit integer from `buf` at the specified `offset` with Reads an unsigned 16-bit integer from `buf` at the specified `offset` with
@ -1656,7 +1697,7 @@ added: v0.5.5
--> -->
* `offset` {Integer} Where to start reading. Must satisfy: `0 <= offset <= buf.length - 4` * `offset` {Integer} Where to start reading. Must satisfy: `0 <= offset <= buf.length - 4`
* `noAssert` {Boolean} Skip `offset` validation? **Default:** `false` * `noAssert` {boolean} Skip `offset` validation? **Default:** `false`
* Returns: {Integer} * Returns: {Integer}
Reads an unsigned 32-bit integer from `buf` at the specified `offset` with Reads an unsigned 32-bit integer from `buf` at the specified `offset` with
@ -1689,7 +1730,7 @@ added: v0.11.15
* `offset` {Integer} Where to start reading. Must satisfy: `0 <= offset <= buf.length - byteLength` * `offset` {Integer} Where to start reading. Must satisfy: `0 <= offset <= buf.length - byteLength`
* `byteLength` {Integer} How many bytes to read. Must satisfy: `0 < byteLength <= 6` * `byteLength` {Integer} How many bytes to read. Must satisfy: `0 < byteLength <= 6`
* `noAssert` {Boolean} Skip `offset` and `byteLength` validation? **Default:** `false` * `noAssert` {boolean} Skip `offset` and `byteLength` validation? **Default:** `false`
* Returns: {Integer} * Returns: {Integer}
Reads `byteLength` number of bytes from `buf` at the specified `offset` Reads `byteLength` number of bytes from `buf` at the specified `offset`
@ -1871,7 +1912,7 @@ for working with 64-bit floats.
added: v0.1.90 added: v0.1.90
--> -->
* `encoding` {String} The character encoding to decode to. **Default:** `'utf8'` * `encoding` {string} The character encoding to decode to. **Default:** `'utf8'`
* `start` {Integer} The byte offset to start decoding at. **Default:** `0` * `start` {Integer} The byte offset to start decoding at. **Default:** `0`
* `end` {Integer} The byte offset to stop decoding at (not inclusive). * `end` {Integer} The byte offset to stop decoding at (not inclusive).
**Default:** [`buf.length`] **Default:** [`buf.length`]
@ -1981,10 +2022,10 @@ for (const value of buf) {
added: v0.1.90 added: v0.1.90
--> -->
* `string` {String} String to be written to `buf` * `string` {string} String to be written to `buf`
* `offset` {Integer} Where to start writing `string`. **Default:** `0` * `offset` {Integer} Where to start writing `string`. **Default:** `0`
* `length` {Integer} How many bytes to write. **Default:** `buf.length - offset` * `length` {Integer} How many bytes to write. **Default:** `buf.length - offset`
* `encoding` {String} The character encoding of `string`. **Default:** `'utf8'` * `encoding` {string} The character encoding of `string`. **Default:** `'utf8'`
* Returns: {Integer} Number of bytes written * Returns: {Integer} Number of bytes written
Writes `string` to `buf` at `offset` according to the character encoding in `encoding`. Writes `string` to `buf` at `offset` according to the character encoding in `encoding`.
@ -2009,9 +2050,9 @@ console.log(`${len} bytes: ${buf.toString('utf8', 0, len)}`);
added: v0.11.15 added: v0.11.15
--> -->
* `value` {Number} Number to be written to `buf` * `value` {number} Number to be written to `buf`
* `offset` {Integer} Where to start writing. Must satisfy: `0 <= offset <= buf.length - 8` * `offset` {Integer} Where to start writing. Must satisfy: `0 <= offset <= buf.length - 8`
* `noAssert` {Boolean} Skip `value` and `offset` validation? **Default:** `false` * `noAssert` {boolean} Skip `value` and `offset` validation? **Default:** `false`
* Returns: {Integer} `offset` plus the number of bytes written * Returns: {Integer} `offset` plus the number of bytes written
Writes `value` to `buf` at the specified `offset` with specified endian Writes `value` to `buf` at the specified `offset` with specified endian
@ -2044,9 +2085,9 @@ console.log(buf);
added: v0.11.15 added: v0.11.15
--> -->
* `value` {Number} Number to be written to `buf` * `value` {number} Number to be written to `buf`
* `offset` {Integer} Where to start writing. Must satisfy: `0 <= offset <= buf.length - 4` * `offset` {Integer} Where to start writing. Must satisfy: `0 <= offset <= buf.length - 4`
* `noAssert` {Boolean} Skip `value` and `offset` validation? **Default:** `false` * `noAssert` {boolean} Skip `value` and `offset` validation? **Default:** `false`
* Returns: {Integer} `offset` plus the number of bytes written * Returns: {Integer} `offset` plus the number of bytes written
Writes `value` to `buf` at the specified `offset` with specified endian Writes `value` to `buf` at the specified `offset` with specified endian
@ -2080,7 +2121,7 @@ added: v0.5.0
* `value` {Integer} Number to be written to `buf` * `value` {Integer} Number to be written to `buf`
* `offset` {Integer} Where to start writing. Must satisfy: `0 <= offset <= buf.length - 1` * `offset` {Integer} Where to start writing. Must satisfy: `0 <= offset <= buf.length - 1`
* `noAssert` {Boolean} Skip `value` and `offset` validation? **Default:** `false` * `noAssert` {boolean} Skip `value` and `offset` validation? **Default:** `false`
* Returns: {Integer} `offset` plus the number of bytes written * Returns: {Integer} `offset` plus the number of bytes written
Writes `value` to `buf` at the specified `offset`. `value` *should* be a valid Writes `value` to `buf` at the specified `offset`. `value` *should* be a valid
@ -2112,7 +2153,7 @@ added: v0.5.5
* `value` {Integer} Number to be written to `buf` * `value` {Integer} Number to be written to `buf`
* `offset` {Integer} Where to start writing. Must satisfy: `0 <= offset <= buf.length - 2` * `offset` {Integer} Where to start writing. Must satisfy: `0 <= offset <= buf.length - 2`
* `noAssert` {Boolean} Skip `value` and `offset` validation? **Default:** `false` * `noAssert` {boolean} Skip `value` and `offset` validation? **Default:** `false`
* Returns: {Integer} `offset` plus the number of bytes written * Returns: {Integer} `offset` plus the number of bytes written
Writes `value` to `buf` at the specified `offset` with specified endian Writes `value` to `buf` at the specified `offset` with specified endian
@ -2145,7 +2186,7 @@ added: v0.5.5
* `value` {Integer} Number to be written to `buf` * `value` {Integer} Number to be written to `buf`
* `offset` {Integer} Where to start writing. Must satisfy: `0 <= offset <= buf.length - 4` * `offset` {Integer} Where to start writing. Must satisfy: `0 <= offset <= buf.length - 4`
* `noAssert` {Boolean} Skip `value` and `offset` validation? **Default:** `false` * `noAssert` {boolean} Skip `value` and `offset` validation? **Default:** `false`
* Returns: {Integer} `offset` plus the number of bytes written * Returns: {Integer} `offset` plus the number of bytes written
Writes `value` to `buf` at the specified `offset` with specified endian Writes `value` to `buf` at the specified `offset` with specified endian
@ -2179,7 +2220,7 @@ added: v0.11.15
* `value` {Integer} Number to be written to `buf` * `value` {Integer} Number to be written to `buf`
* `offset` {Integer} Where to start writing. Must satisfy: `0 <= offset <= buf.length - byteLength` * `offset` {Integer} Where to start writing. Must satisfy: `0 <= offset <= buf.length - byteLength`
* `byteLength` {Integer} How many bytes to write. Must satisfy: `0 < byteLength <= 6` * `byteLength` {Integer} How many bytes to write. Must satisfy: `0 < byteLength <= 6`
* `noAssert` {Boolean} Skip `value`, `offset`, and `byteLength` validation? * `noAssert` {boolean} Skip `value`, `offset`, and `byteLength` validation?
**Default:** `false` **Default:** `false`
* Returns: {Integer} `offset` plus the number of bytes written * Returns: {Integer} `offset` plus the number of bytes written
@ -2213,7 +2254,7 @@ added: v0.5.0
* `value` {Integer} Number to be written to `buf` * `value` {Integer} Number to be written to `buf`
* `offset` {Integer} Where to start writing. Must satisfy: `0 <= offset <= buf.length - 1` * `offset` {Integer} Where to start writing. Must satisfy: `0 <= offset <= buf.length - 1`
* `noAssert` {Boolean} Skip `value` and `offset` validation? **Default:** `false` * `noAssert` {boolean} Skip `value` and `offset` validation? **Default:** `false`
* Returns: {Integer} `offset` plus the number of bytes written * Returns: {Integer} `offset` plus the number of bytes written
Writes `value` to `buf` at the specified `offset`. `value` *should* be a Writes `value` to `buf` at the specified `offset`. `value` *should* be a
@ -2245,7 +2286,7 @@ added: v0.5.5
* `value` {Integer} Number to be written to `buf` * `value` {Integer} Number to be written to `buf`
* `offset` {Integer} Where to start writing. Must satisfy: `0 <= offset <= buf.length - 2` * `offset` {Integer} Where to start writing. Must satisfy: `0 <= offset <= buf.length - 2`
* `noAssert` {Boolean} Skip `value` and `offset` validation? **Default:** `false` * `noAssert` {boolean} Skip `value` and `offset` validation? **Default:** `false`
* Returns: {Integer} `offset` plus the number of bytes written * Returns: {Integer} `offset` plus the number of bytes written
Writes `value` to `buf` at the specified `offset` with specified endian Writes `value` to `buf` at the specified `offset` with specified endian
@ -2282,7 +2323,7 @@ added: v0.5.5
* `value` {Integer} Number to be written to `buf` * `value` {Integer} Number to be written to `buf`
* `offset` {Integer} Where to start writing. Must satisfy: `0 <= offset <= buf.length - 4` * `offset` {Integer} Where to start writing. Must satisfy: `0 <= offset <= buf.length - 4`
* `noAssert` {Boolean} Skip `value` and `offset` validation? **Default:** `false` * `noAssert` {boolean} Skip `value` and `offset` validation? **Default:** `false`
* Returns: {Integer} `offset` plus the number of bytes written * Returns: {Integer} `offset` plus the number of bytes written
Writes `value` to `buf` at the specified `offset` with specified endian Writes `value` to `buf` at the specified `offset` with specified endian
@ -2318,7 +2359,7 @@ added: v0.5.5
* `value` {Integer} Number to be written to `buf` * `value` {Integer} Number to be written to `buf`
* `offset` {Integer} Where to start writing. Must satisfy: `0 <= offset <= buf.length - byteLength` * `offset` {Integer} Where to start writing. Must satisfy: `0 <= offset <= buf.length - byteLength`
* `byteLength` {Integer} How many bytes to write. Must satisfy: `0 < byteLength <= 6` * `byteLength` {Integer} How many bytes to write. Must satisfy: `0 < byteLength <= 6`
* `noAssert` {Boolean} Skip `value`, `offset`, and `byteLength` validation? * `noAssert` {boolean} Skip `value`, `offset`, and `byteLength` validation?
**Default:** `false` **Default:** `false`
* Returns: {Integer} `offset` plus the number of bytes written * Returns: {Integer} `offset` plus the number of bytes written

148
doc/api/child_process.md
View File

@ -125,25 +125,25 @@ exec('"my script.cmd" a b', (err, stdout, stderr) => {
added: v0.1.90 added: v0.1.90
--> -->
* `command` {String} The command to run, with space-separated arguments * `command` {string} The command to run, with space-separated arguments
* `options` {Object} * `options` {Object}
* `cwd` {String} Current working directory of the child process * `cwd` {string} Current working directory of the child process
* `env` {Object} Environment key-value pairs * `env` {Object} Environment key-value pairs
* `encoding` {String} (Default: `'utf8'`) * `encoding` {string} (Default: `'utf8'`)
* `shell` {String} Shell to execute the command with * `shell` {string} Shell to execute the command with
(Default: `'/bin/sh'` on UNIX, `'cmd.exe'` on Windows, The shell should (Default: `'/bin/sh'` on UNIX, `'cmd.exe'` on Windows, The shell should
understand the `-c` switch on UNIX or `/s /c` on Windows. On Windows, understand the `-c` switch on UNIX or `/s /c` on Windows. On Windows,
command line parsing should be compatible with `cmd.exe`.) command line parsing should be compatible with `cmd.exe`.)
* `timeout` {Number} (Default: `0`) * `timeout` {number} (Default: `0`)
* [`maxBuffer`][] {Number} largest amount of data (in bytes) allowed on * [`maxBuffer`][] {Number} largest amount of data (in bytes) allowed on
stdout or stderr - if exceeded child process is killed (Default: `200*1024`) stdout or stderr - if exceeded child process is killed (Default: `200*1024`)
* `killSignal` {String|Integer} (Default: `'SIGTERM'`) * `killSignal` {string|Integer} (Default: `'SIGTERM'`)
* `uid` {Number} Sets the user identity of the process. (See setuid(2).) * `uid` {number} Sets the user identity of the process. (See setuid(2).)
* `gid` {Number} Sets the group identity of the process. (See setgid(2).) * `gid` {number} Sets the group identity of the process. (See setgid(2).)
* `callback` {Function} called with the output when process terminates * `callback` {Function} called with the output when process terminates
* `error` {Error} * `error` {Error}
* `stdout` {String|Buffer} * `stdout` {string|Buffer}
* `stderr` {String|Buffer} * `stderr` {string|Buffer}
* Returns: {ChildProcess} * Returns: {ChildProcess}
Spawns a shell then executes the `command` within that shell, buffering any Spawns a shell then executes the `command` within that shell, buffering any
@ -205,22 +205,22 @@ replace the existing process and uses a shell to execute the command.*
added: v0.1.91 added: v0.1.91
--> -->
* `file` {String} The name or path of the executable file to run * `file` {string} The name or path of the executable file to run
* `args` {Array} List of string arguments * `args` {Array} List of string arguments
* `options` {Object} * `options` {Object}
* `cwd` {String} Current working directory of the child process * `cwd` {string} Current working directory of the child process
* `env` {Object} Environment key-value pairs * `env` {Object} Environment key-value pairs
* `encoding` {String} (Default: `'utf8'`) * `encoding` {string} (Default: `'utf8'`)
* `timeout` {Number} (Default: `0`) * `timeout` {number} (Default: `0`)
* [`maxBuffer`][] {Number} largest amount of data (in bytes) allowed on * [`maxBuffer`][] {Number} largest amount of data (in bytes) allowed on
stdout or stderr - if exceeded child process is killed (Default: `200*1024`) stdout or stderr - if exceeded child process is killed (Default: `200*1024`)
* `killSignal` {String|Integer} (Default: `'SIGTERM'`) * `killSignal` {string|Integer} (Default: `'SIGTERM'`)
* `uid` {Number} Sets the user identity of the process. (See setuid(2).) * `uid` {number} Sets the user identity of the process. (See setuid(2).)
* `gid` {Number} Sets the group identity of the process. (See setgid(2).) * `gid` {number} Sets the group identity of the process. (See setgid(2).)
* `callback` {Function} called with the output when process terminates * `callback` {Function} called with the output when process terminates
* `error` {Error} * `error` {Error}
* `stdout` {String|Buffer} * `stdout` {string|Buffer}
* `stderr` {String|Buffer} * `stderr` {string|Buffer}
* Returns: {ChildProcess} * Returns: {ChildProcess}
The `child_process.execFile()` function is similar to [`child_process.exec()`][] The `child_process.execFile()` function is similar to [`child_process.exec()`][]
@ -253,15 +253,15 @@ encoding, `Buffer` objects will be passed to the callback instead.
added: v0.5.0 added: v0.5.0
--> -->
* `modulePath` {String} The module to run in the child * `modulePath` {string} The module to run in the child
* `args` {Array} List of string arguments * `args` {Array} List of string arguments
* `options` {Object} * `options` {Object}
* `cwd` {String} Current working directory of the child process * `cwd` {string} Current working directory of the child process
* `env` {Object} Environment key-value pairs * `env` {Object} Environment key-value pairs
* `execPath` {String} Executable used to create the child process * `execPath` {string} Executable used to create the child process
* `execArgv` {Array} List of string arguments passed to the executable * `execArgv` {Array} List of string arguments passed to the executable
(Default: `process.execArgv`) (Default: `process.execArgv`)
* `silent` {Boolean} If `true`, stdin, stdout, and stderr of the child will be * `silent` {boolean} If `true`, stdin, stdout, and stderr of the child will be
piped to the parent, otherwise they will be inherited from the parent, see piped to the parent, otherwise they will be inherited from the parent, see
the `'pipe'` and `'inherit'` options for [`child_process.spawn()`][]'s the `'pipe'` and `'inherit'` options for [`child_process.spawn()`][]'s
[`stdio`][] for more details (Default: `false`) [`stdio`][] for more details (Default: `false`)
@ -269,8 +269,8 @@ added: v0.5.0
[`stdio`][] option. When this option is provided, it overrides `silent`. [`stdio`][] option. When this option is provided, it overrides `silent`.
The array must contain exactly one item with value `'ipc'` or an error will The array must contain exactly one item with value `'ipc'` or an error will
be thrown. For instance `[0, 1, 2, 'ipc']`. be thrown. For instance `[0, 1, 2, 'ipc']`.
* `uid` {Number} Sets the user identity of the process. (See setuid(2).) * `uid` {number} Sets the user identity of the process. (See setuid(2).)
* `gid` {Number} Sets the group identity of the process. (See setgid(2).) * `gid` {number} Sets the group identity of the process. (See setgid(2).)
* Returns: {ChildProcess} * Returns: {ChildProcess}
The `child_process.fork()` method is a special case of The `child_process.fork()` method is a special case of
@ -304,21 +304,21 @@ not clone the current process.*
added: v0.1.90 added: v0.1.90
--> -->
* `command` {String} The command to run * `command` {string} The command to run
* `args` {Array} List of string arguments * `args` {Array} List of string arguments
* `options` {Object} * `options` {Object}
* `cwd` {String} Current working directory of the child process * `cwd` {string} Current working directory of the child process
* `env` {Object} Environment key-value pairs * `env` {Object} Environment key-value pairs
* `argv0` {String} Explicitly set the value of `argv[0]` sent to the child * `argv0` {string} Explicitly set the value of `argv[0]` sent to the child
process. This will be set to `command` if not specified. process. This will be set to `command` if not specified.
* `stdio` {Array|String} Child's stdio configuration. (See * `stdio` {Array|string} Child's stdio configuration. (See
[`options.stdio`][`stdio`]) [`options.stdio`][`stdio`])
* `detached` {Boolean} Prepare child to run independently of its parent * `detached` {boolean} Prepare child to run independently of its parent
process. Specific behavior depends on the platform, see process. Specific behavior depends on the platform, see
[`options.detached`][]) [`options.detached`][])
* `uid` {Number} Sets the user identity of the process. (See setuid(2).) * `uid` {number} Sets the user identity of the process. (See setuid(2).)
* `gid` {Number} Sets the group identity of the process. (See setgid(2).) * `gid` {number} Sets the group identity of the process. (See setgid(2).)
* `shell` {Boolean|String} If `true`, runs `command` inside of a shell. Uses * `shell` {boolean|string} If `true`, runs `command` inside of a shell. Uses
`'/bin/sh'` on UNIX, and `'cmd.exe'` on Windows. A different shell can be `'/bin/sh'` on UNIX, and `'cmd.exe'` on Windows. A different shell can be
specified as a string. The shell should understand the `-c` switch on UNIX, specified as a string. The shell should understand the `-c` switch on UNIX,
or `/s /c` on Windows. Defaults to `false` (no shell). or `/s /c` on Windows. Defaults to `false` (no shell).
@ -576,27 +576,27 @@ configuration at startup.
added: v0.11.12 added: v0.11.12
--> -->
* `file` {String} The name or path of the executable file to run * `file` {string} The name or path of the executable file to run
* `args` {Array} List of string arguments * `args` {Array} List of string arguments
* `options` {Object} * `options` {Object}
* `cwd` {String} Current working directory of the child process * `cwd` {string} Current working directory of the child process
* `input` {String|Buffer} The value which will be passed as stdin to the * `input` {string|Buffer} The value which will be passed as stdin to the
spawned process spawned process
- supplying this value will override `stdio[0]` - supplying this value will override `stdio[0]`
* `stdio` {String | Array} Child's stdio configuration. (Default: `'pipe'`) * `stdio` {string | Array} Child's stdio configuration. (Default: `'pipe'`)
- `stderr` by default will be output to the parent process' stderr unless - `stderr` by default will be output to the parent process' stderr unless
`stdio` is specified `stdio` is specified
* `env` {Object} Environment key-value pairs * `env` {Object} Environment key-value pairs
* `uid` {Number} Sets the user identity of the process. (See setuid(2).) * `uid` {number} Sets the user identity of the process. (See setuid(2).)
* `gid` {Number} Sets the group identity of the process. (See setgid(2).) * `gid` {number} Sets the group identity of the process. (See setgid(2).)
* `timeout` {Number} In milliseconds the maximum amount of time the process * `timeout` {number} In milliseconds the maximum amount of time the process
is allowed to run. (Default: `undefined`) is allowed to run. (Default: `undefined`)
* `killSignal` {String|Integer} The signal value to be used when the spawned * `killSignal` {string|Integer} The signal value to be used when the spawned
process will be killed. (Default: `'SIGTERM'`) process will be killed. (Default: `'SIGTERM'`)
* [`maxBuffer`][] {Number} largest amount of data (in bytes) allowed on * [`maxBuffer`][] {Number} largest amount of data (in bytes) allowed on
stdout or stderr - if exceeded child process is killed stdout or stderr - if exceeded child process is killed
* `encoding` {String} The encoding used for all stdio inputs and outputs. (Default: `'buffer'`) * `encoding` {string} The encoding used for all stdio inputs and outputs. (Default: `'buffer'`)
* Returns: {Buffer|String} The stdout from the command * Returns: {Buffer|string} The stdout from the command
The `child_process.execFileSync()` method is generally identical to The `child_process.execFileSync()` method is generally identical to
[`child_process.execFile()`][] with the exception that the method will not return [`child_process.execFile()`][] with the exception that the method will not return
@ -615,31 +615,31 @@ throw. The [`Error`][] object will contain the entire result from
added: v0.11.12 added: v0.11.12
--> -->
* `command` {String} The command to run * `command` {string} The command to run
* `options` {Object} * `options` {Object}
* `cwd` {String} Current working directory of the child process * `cwd` {string} Current working directory of the child process
* `input` {String|Buffer} The value which will be passed as stdin to the * `input` {string|Buffer} The value which will be passed as stdin to the
spawned process spawned process
- supplying this value will override `stdio[0]` - supplying this value will override `stdio[0]`
* `stdio` {String | Array} Child's stdio configuration. (Default: `'pipe'`) * `stdio` {string | Array} Child's stdio configuration. (Default: `'pipe'`)
- `stderr` by default will be output to the parent process' stderr unless - `stderr` by default will be output to the parent process' stderr unless
`stdio` is specified `stdio` is specified
* `env` {Object} Environment key-value pairs * `env` {Object} Environment key-value pairs
* `shell` {String} Shell to execute the command with * `shell` {string} Shell to execute the command with
(Default: `'/bin/sh'` on UNIX, `'cmd.exe'` on Windows, The shell should (Default: `'/bin/sh'` on UNIX, `'cmd.exe'` on Windows, The shell should
understand the `-c` switch on UNIX or `/s /c` on Windows. On Windows, understand the `-c` switch on UNIX or `/s /c` on Windows. On Windows,
command line parsing should be compatible with `cmd.exe`.) command line parsing should be compatible with `cmd.exe`.)
* `uid` {Number} Sets the user identity of the process. (See setuid(2).) * `uid` {number} Sets the user identity of the process. (See setuid(2).)
* `gid` {Number} Sets the group identity of the process. (See setgid(2).) * `gid` {number} Sets the group identity of the process. (See setgid(2).)
* `timeout` {Number} In milliseconds the maximum amount of time the process * `timeout` {number} In milliseconds the maximum amount of time the process
is allowed to run. (Default: `undefined`) is allowed to run. (Default: `undefined`)
* `killSignal` {String|Integer} The signal value to be used when the spawned * `killSignal` {string|Integer} The signal value to be used when the spawned
process will be killed. (Default: `'SIGTERM'`) process will be killed. (Default: `'SIGTERM'`)
* [`maxBuffer`][] {Number} largest amount of data (in bytes) allowed on * [`maxBuffer`][] {Number} largest amount of data (in bytes) allowed on
stdout or stderr - if exceeded child process is killed stdout or stderr - if exceeded child process is killed
* `encoding` {String} The encoding used for all stdio inputs and outputs. * `encoding` {string} The encoding used for all stdio inputs and outputs.
(Default: `'buffer'`) (Default: `'buffer'`)
* Returns: {Buffer|String} The stdout from the command * Returns: {Buffer|string} The stdout from the command
The `child_process.execSync()` method is generally identical to The `child_process.execSync()` method is generally identical to
[`child_process.exec()`][] with the exception that the method will not return until [`child_process.exec()`][] with the exception that the method will not return until
@ -662,36 +662,36 @@ execution.**
added: v0.11.12 added: v0.11.12
--> -->
* `command` {String} The command to run * `command` {string} The command to run
* `args` {Array} List of string arguments * `args` {Array} List of string arguments
* `options` {Object} * `options` {Object}
* `cwd` {String} Current working directory of the child process * `cwd` {string} Current working directory of the child process
* `input` {String|Buffer} The value which will be passed as stdin to the * `input` {string|Buffer} The value which will be passed as stdin to the
spawned process spawned process
- supplying this value will override `stdio[0]` - supplying this value will override `stdio[0]`
* `stdio` {String | Array} Child's stdio configuration. * `stdio` {string | Array} Child's stdio configuration.
* `env` {Object} Environment key-value pairs * `env` {Object} Environment key-value pairs
* `uid` {Number} Sets the user identity of the process. (See setuid(2).) * `uid` {number} Sets the user identity of the process. (See setuid(2).)
* `gid` {Number} Sets the group identity of the process. (See setgid(2).) * `gid` {number} Sets the group identity of the process. (See setgid(2).)
* `timeout` {Number} In milliseconds the maximum amount of time the process * `timeout` {number} In milliseconds the maximum amount of time the process
is allowed to run. (Default: `undefined`) is allowed to run. (Default: `undefined`)
* `killSignal` {String|Integer} The signal value to be used when the spawned * `killSignal` {string|Integer} The signal value to be used when the spawned
process will be killed. (Default: `'SIGTERM'`) process will be killed. (Default: `'SIGTERM'`)
* [`maxBuffer`][] {Number} largest amount of data (in bytes) allowed on * [`maxBuffer`][] {Number} largest amount of data (in bytes) allowed on
stdout or stderr - if exceeded child process is killed stdout or stderr - if exceeded child process is killed
* `encoding` {String} The encoding used for all stdio inputs and outputs. * `encoding` {string} The encoding used for all stdio inputs and outputs.
(Default: `'buffer'`) (Default: `'buffer'`)
* `shell` {Boolean|String} If `true`, runs `command` inside of a shell. Uses * `shell` {boolean|string} If `true`, runs `command` inside of a shell. Uses
`'/bin/sh'` on UNIX, and `'cmd.exe'` on Windows. A different shell can be `'/bin/sh'` on UNIX, and `'cmd.exe'` on Windows. A different shell can be
specified as a string. The shell should understand the `-c` switch on UNIX, specified as a string. The shell should understand the `-c` switch on UNIX,
or `/s /c` on Windows. Defaults to `false` (no shell). or `/s /c` on Windows. Defaults to `false` (no shell).
* Returns: {Object} * Returns: {Object}
* `pid` {Number} Pid of the child process * `pid` {number} Pid of the child process
* `output` {Array} Array of results from stdio output * `output` {Array} Array of results from stdio output
* `stdout` {Buffer|String} The contents of `output[1]` * `stdout` {Buffer|string} The contents of `output[1]`
* `stderr` {Buffer|String} The contents of `output[2]` * `stderr` {Buffer|string} The contents of `output[2]`
* `status` {Number} The exit code of the child process * `status` {number} The exit code of the child process
* `signal` {String} The signal used to kill the child process * `signal` {string} The signal used to kill the child process
* `error` {Error} The error object if the child process failed or timed out * `error` {Error} The error object if the child process failed or timed out
The `child_process.spawnSync()` method is generally identical to The `child_process.spawnSync()` method is generally identical to
@ -724,8 +724,8 @@ instances of `ChildProcess`.
added: v0.7.7 added: v0.7.7
--> -->
* `code` {Number} the exit code if the child exited on its own. * `code` {number} the exit code if the child exited on its own.
* `signal` {String} the signal by which the child process was terminated. * `signal` {string} the signal by which the child process was terminated.
The `'close'` event is emitted when the stdio streams of a child process have The `'close'` event is emitted when the stdio streams of a child process have
been closed. This is distinct from the [`'exit'`][] event, since multiple been closed. This is distinct from the [`'exit'`][] event, since multiple
@ -762,8 +762,8 @@ See also [`child.kill()`][] and [`child.send()`][].
added: v0.1.90 added: v0.1.90
--> -->
* `code` {Number} the exit code if the child exited on its own. * `code` {number} the exit code if the child exited on its own.
* `signal` {String} the signal by which the child process was terminated. * `signal` {string} the signal by which the child process was terminated.
The `'exit'` event is emitted after the child process ends. If the process The `'exit'` event is emitted after the child process ends. If the process
exited, `code` is the final exit code of the process, otherwise `null`. If the exited, `code` is the final exit code of the process, otherwise `null`. If the
@ -827,7 +827,7 @@ within the child process to close the IPC channel as well.
added: v0.1.90 added: v0.1.90
--> -->
* `signal` {String} * `signal` {string}
The `child.kill()` methods sends a signal to the child process. If no argument The `child.kill()` methods sends a signal to the child process. If no argument
is given, the process will be sent the `'SIGTERM'` signal. See signal(7) for is given, the process will be sent the `'SIGTERM'` signal. See signal(7) for

22
doc/api/cluster.md
View File

@ -148,8 +148,8 @@ In a worker you can also use `process.on('error')`.
added: v0.11.2 added: v0.11.2
--> -->
* `code` {Number} the exit code, if it exited normally. * `code` {number} the exit code, if it exited normally.
* `signal` {String} the name of the signal (e.g. `'SIGHUP'`) that caused * `signal` {string} the name of the signal (e.g. `'SIGHUP'`) that caused
the process to be killed. the process to be killed.
Similar to the `cluster.on('exit')` event, but specific to this worker. Similar to the `cluster.on('exit')` event, but specific to this worker.
@ -382,7 +382,7 @@ because of exiting or being signaled). Otherwise, it returns `false`.
added: v0.9.12 added: v0.9.12
--> -->
* `signal` {String} Name of the kill signal to send to the worker * `signal` {string} Name of the kill signal to send to the worker
process. process.
This function will kill the worker. In the master, it does this by disconnecting This function will kill the worker. In the master, it does this by disconnecting
@ -502,8 +502,8 @@ added: v0.7.9
--> -->
* `worker` {cluster.Worker} * `worker` {cluster.Worker}
* `code` {Number} the exit code, if it exited normally. * `code` {number} the exit code, if it exited normally.
* `signal` {String} the name of the signal (e.g. `'SIGHUP'`) that caused * `signal` {string} the name of the signal (e.g. `'SIGHUP'`) that caused
the process to be killed. the process to be killed.
When any of the workers die the cluster module will emit the `'exit'` event. When any of the workers die the cluster module will emit the `'exit'` event.
@ -713,16 +713,16 @@ added: v0.7.1
* {Object} * {Object}
* `execArgv` {Array} list of string arguments passed to the Node.js * `execArgv` {Array} list of string arguments passed to the Node.js
executable. (Default=`process.execArgv`) executable. (Default=`process.execArgv`)
* `exec` {String} file path to worker file. (Default=`process.argv[1]`) * `exec` {string} file path to worker file. (Default=`process.argv[1]`)
* `args` {Array} string arguments passed to worker. * `args` {Array} string arguments passed to worker.
(Default=`process.argv.slice(2)`) (Default=`process.argv.slice(2)`)
* `silent` {Boolean} whether or not to send output to parent's stdio. * `silent` {boolean} whether or not to send output to parent's stdio.
(Default=`false`) (Default=`false`)
* `stdio` {Array} Configures the stdio of forked processes. Because the * `stdio` {Array} Configures the stdio of forked processes. Because the
cluster module relies on IPC to function, this configuration must contain an cluster module relies on IPC to function, this configuration must contain an
`'ipc'` entry. When this option is provided, it overrides `silent`. `'ipc'` entry. When this option is provided, it overrides `silent`.
* `uid` {Number} Sets the user identity of the process. (See setuid(2).) * `uid` {number} Sets the user identity of the process. (See setuid(2).)
* `gid` {Number} Sets the group identity of the process. (See setgid(2).) * `gid` {number} Sets the group identity of the process. (See setgid(2).)
After calling `.setupMaster()` (or `.fork()`) this settings object will contain After calling `.setupMaster()` (or `.fork()`) this settings object will contain
the settings, including the default values. the settings, including the default values.
@ -735,10 +735,10 @@ added: v0.7.1
--> -->
* `settings` {Object} * `settings` {Object}
* `exec` {String} file path to worker file. (Default=`process.argv[1]`) * `exec` {string} file path to worker file. (Default=`process.argv[1]`)
* `args` {Array} string arguments passed to worker. * `args` {Array} string arguments passed to worker.
(Default=`process.argv.slice(2)`) (Default=`process.argv.slice(2)`)
* `silent` {Boolean} whether or not to send output to parent's stdio. * `silent` {boolean} whether or not to send output to parent's stdio.
(Default=`false`) (Default=`false`)
* `stdio` {Array} Configures the stdio of forked processes. When this option * `stdio` {Array} Configures the stdio of forked processes. When this option
is provided, it overrides `silent`. is provided, it overrides `silent`.

46
doc/api/dgram.md
View File

@ -74,18 +74,18 @@ The `'message'` event is emitted when a new datagram is available on a socket.
The event handler function is passed two arguments: `msg` and `rinfo`. The event handler function is passed two arguments: `msg` and `rinfo`.
* `msg` {Buffer} - The message * `msg` {Buffer} - The message
* `rinfo` {Object} - Remote address information * `rinfo` {Object} - Remote address information
* `address` {String} The sender address * `address` {string} The sender address
* `family` {String} The address family (`'IPv4'` or `'IPv6'`) * `family` {string} The address family (`'IPv4'` or `'IPv6'`)
* `port` {Number} The sender port * `port` {number} The sender port
* `size` {Number} The message size * `size` {number} The message size
### socket.addMembership(multicastAddress[, multicastInterface]) ### socket.addMembership(multicastAddress[, multicastInterface])
<!-- YAML <!-- YAML
added: v0.6.9 added: v0.6.9
--> -->
* `multicastAddress` {String} * `multicastAddress` {string}
* `multicastInterface` {String}, Optional * `multicastInterface` {string}, Optional
Tells the kernel to join a multicast group at the given `multicastAddress` and Tells the kernel to join a multicast group at the given `multicastAddress` and
`multicastInterface` using the `IP_ADD_MEMBERSHIP` socket option. If the `multicastInterface` using the `IP_ADD_MEMBERSHIP` socket option. If the
@ -107,8 +107,8 @@ properties.
added: v0.1.99 added: v0.1.99
--> -->
* `port` {Number} - Integer, Optional * `port` {number} - Integer, Optional
* `address` {String}, Optional * `address` {string}, Optional
* `callback` {Function} with no parameters, Optional. Called when * `callback` {Function} with no parameters, Optional. Called when
binding is complete. binding is complete.
@ -160,9 +160,9 @@ added: v0.11.14
--> -->
* `options` {Object} - Required. Supports the following properties: * `options` {Object} - Required. Supports the following properties:
* `port` {Number} - Optional. * `port` {number} - Optional.
* `address` {String} - Optional. * `address` {string} - Optional.
* `exclusive` {Boolean} - Optional. * `exclusive` {boolean} - Optional.
* `callback` {Function} - Optional. * `callback` {Function} - Optional.
For UDP sockets, causes the `dgram.Socket` to listen for datagram For UDP sockets, causes the `dgram.Socket` to listen for datagram
@ -214,8 +214,8 @@ provided, it is added as a listener for the [`'close'`][] event.
added: v0.6.9 added: v0.6.9
--> -->
* `multicastAddress` {String} * `multicastAddress` {string}
* `multicastInterface` {String}, Optional * `multicastInterface` {string}, Optional
Instructs the kernel to leave a multicast group at `multicastAddress` using the Instructs the kernel to leave a multicast group at `multicastAddress` using the
`IP_DROP_MEMBERSHIP` socket option. This method is automatically called by the `IP_DROP_MEMBERSHIP` socket option. This method is automatically called by the
@ -230,11 +230,11 @@ drop membership on all valid interfaces.
added: v0.1.99 added: v0.1.99
--> -->
* `msg` {Buffer|String|Array} Message to be sent * `msg` {Buffer|string|array} Message to be sent
* `offset` {Number} Integer. Optional. Offset in the buffer where the message starts. * `offset` {number} Integer. Optional. Offset in the buffer where the message starts.
* `length` {Number} Integer. Optional. Number of bytes in the message. * `length` {number} Integer. Optional. Number of bytes in the message.
* `port` {Number} Integer. Destination port. * `port` {number} Integer. Destination port.
* `address` {String} Destination hostname or IP address. * `address` {string} Destination hostname or IP address.
* `callback` {Function} Called when the message has been sent. Optional. * `callback` {Function} Called when the message has been sent. Optional.
Broadcasts a datagram on the socket. The destination `port` and `address` must Broadcasts a datagram on the socket. The destination `port` and `address` must
@ -330,7 +330,7 @@ source that the data did not reach its intended recipient.
added: v0.6.9 added: v0.6.9
--> -->
* `flag` {Boolean} * `flag` {boolean}
Sets or clears the `SO_BROADCAST` socket option. When set to `true`, UDP Sets or clears the `SO_BROADCAST` socket option. When set to `true`, UDP
packets may be sent to a local interface's broadcast address. packets may be sent to a local interface's broadcast address.
@ -340,7 +340,7 @@ packets may be sent to a local interface's broadcast address.
added: v0.3.8 added: v0.3.8
--> -->
* `flag` {Boolean} * `flag` {boolean}
Sets or clears the `IP_MULTICAST_LOOP` socket option. When set to `true`, Sets or clears the `IP_MULTICAST_LOOP` socket option. When set to `true`,
multicast packets will also be received on the local interface. multicast packets will also be received on the local interface.
@ -350,7 +350,7 @@ multicast packets will also be received on the local interface.
added: v0.3.8 added: v0.3.8
--> -->
* `ttl` {Number} Integer * `ttl` {number} Integer
Sets the `IP_MULTICAST_TTL` socket option. While TTL generally stands for Sets the `IP_MULTICAST_TTL` socket option. While TTL generally stands for
"Time to Live", in this context it specifies the number of IP hops that a "Time to Live", in this context it specifies the number of IP hops that a
@ -366,7 +366,7 @@ between 0 and 255. The default on most systems is `1` but can vary.
added: v0.1.101 added: v0.1.101
--> -->
* `ttl` {Number} Integer * `ttl` {number} Integer
Sets the `IP_TTL` socket option. While TTL generally stands for "Time to Live", Sets the `IP_TTL` socket option. While TTL generally stands for "Time to Live",
in this context it specifies the number of IP hops that a packet is allowed to in this context it specifies the number of IP hops that a packet is allowed to
@ -463,7 +463,7 @@ and `udp6` sockets). The bound address and port can be retrieved using
added: v0.1.99 added: v0.1.99
--> -->
* `type` {String} - Either 'udp4' or 'udp6' * `type` {string} - Either 'udp4' or 'udp6'
* `callback` {Function} - Attached as a listener to `'message'` events. * `callback` {Function} - Attached as a listener to `'message'` events.
Optional Optional
* Returns: {dgram.Socket} * Returns: {dgram.Socket}

10
doc/api/dns.md
View File

@ -74,7 +74,7 @@ an integer, then it must be `4` or `6`.
Alternatively, `options` can be an object containing these properties: Alternatively, `options` can be an object containing these properties:
* `family` {Number} - The record family. If present, must be the integer * `family` {number} - The record family. If present, must be the integer
`4` or `6`. If not provided, both IP v4 and v6 addresses are accepted. `4` or `6`. If not provided, both IP v4 and v6 addresses are accepted.
* `hints`: {Number} - If present, it should be one or more of the supported * `hints`: {Number} - If present, it should be one or more of the supported
`getaddrinfo` flags. If `hints` is not provided, then no flags are passed to `getaddrinfo` flags. If `hints` is not provided, then no flags are passed to
@ -205,9 +205,9 @@ Uses the DNS protocol to resolve a IPv4 addresses (`A` records) for the
will contain an array of IPv4 addresses (e.g. will contain an array of IPv4 addresses (e.g.
`['74.125.79.104', '74.125.79.105', '74.125.79.106']`). `['74.125.79.104', '74.125.79.105', '74.125.79.106']`).
* `hostname` {String} Hostname to resolve. * `hostname` {string} Hostname to resolve.
* `options` {Object} * `options` {Object}
* `ttl` {Boolean} Retrieve the Time-To-Live value (TTL) of each record. * `ttl` {boolean} Retrieve the Time-To-Live value (TTL) of each record.
The callback receives an array of `{ address: '1.2.3.4', ttl: 60 }` objects The callback receives an array of `{ address: '1.2.3.4', ttl: 60 }` objects
rather than an array of strings. The TTL is expressed in seconds. rather than an array of strings. The TTL is expressed in seconds.
* `callback` {Function} An `(err, result)` callback function. * `callback` {Function} An `(err, result)` callback function.
@ -221,9 +221,9 @@ Uses the DNS protocol to resolve a IPv6 addresses (`AAAA` records) for the
`hostname`. The `addresses` argument passed to the `callback` function `hostname`. The `addresses` argument passed to the `callback` function
will contain an array of IPv6 addresses. will contain an array of IPv6 addresses.
* `hostname` {String} Hostname to resolve. * `hostname` {string} Hostname to resolve.
* `options` {Object} * `options` {Object}
* `ttl` {Boolean} Retrieve the Time-To-Live value (TTL) of each record. * `ttl` {boolean} Retrieve the Time-To-Live value (TTL) of each record.
The callback receives an array of `{ address: '0:1:2:3:4:5:6:7', ttl: 60 }` The callback receives an array of `{ address: '0:1:2:3:4:5:6:7', ttl: 60 }`
objects rather than an array of strings. The TTL is expressed in seconds. objects rather than an array of strings. The TTL is expressed in seconds.
* `callback` {Function} An `(err, result)` callback function. * `callback` {Function} An `(err, result)` callback function.

2
doc/api/errors.md
View File

@ -196,7 +196,7 @@ will either be instances of, or inherit from, the `Error` class.
### new Error(message) ### new Error(message)
* `message` {String} * `message` {string}
Creates a new `Error` object and sets the `error.message` property to the Creates a new `Error` object and sets the `error.message` property to the
provided text message. If an object is passed as `message`, the text message provided text message. If an object is passed as `message`, the text message

14
doc/api/events.md
View File

@ -185,7 +185,7 @@ added and `'removeListener'` when existing listeners are removed.
added: v0.1.26 added: v0.1.26
--> -->
* `eventName` {String|Symbol} The name of the event being listened for * `eventName` {string|symbol} The name of the event being listened for
* `listener` {Function} The event handler function * `listener` {Function} The event handler function
The `EventEmitter` instance will emit its own `'newListener'` event *before* The `EventEmitter` instance will emit its own `'newListener'` event *before*
@ -224,7 +224,7 @@ myEmitter.emit('event');
added: v0.9.3 added: v0.9.3
--> -->
* `eventName` {String|Symbol} The event name * `eventName` {string|symbol} The event name
* `listener` {Function} The event handler function * `listener` {Function} The event handler function
The `'removeListener'` event is emitted *after* the `listener` is removed. The `'removeListener'` event is emitted *after* the `listener` is removed.
@ -339,7 +339,7 @@ set by [`emitter.setMaxListeners(n)`][] or defaults to
added: v3.2.0 added: v3.2.0
--> -->
* `eventName` {String|Symbol} The name of the event being listened for * `eventName` {string|symbol} The name of the event being listened for
Returns the number of listeners listening to the event named `eventName`. Returns the number of listeners listening to the event named `eventName`.
@ -363,7 +363,7 @@ console.log(util.inspect(server.listeners('connection')));
added: v0.1.101 added: v0.1.101
--> -->
* `eventName` {String|Symbol} The name of the event. * `eventName` {string|symbol} The name of the event.
* `listener` {Function} The callback function * `listener` {Function} The callback function
Adds the `listener` function to the end of the listeners array for the Adds the `listener` function to the end of the listeners array for the
@ -399,7 +399,7 @@ myEE.emit('foo');
added: v0.3.0 added: v0.3.0
--> -->
* `eventName` {String|Symbol} The name of the event. * `eventName` {string|symbol} The name of the event.
* `listener` {Function} The callback function * `listener` {Function} The callback function
Adds a **one time** `listener` function for the event named `eventName`. The Adds a **one time** `listener` function for the event named `eventName`. The
@ -432,7 +432,7 @@ myEE.emit('foo');
added: v6.0.0 added: v6.0.0
--> -->
* `eventName` {String|Symbol} The name of the event. * `eventName` {string|symbol} The name of the event.
* `listener` {Function} The callback function * `listener` {Function} The callback function
Adds the `listener` function to the *beginning* of the listeners array for the Adds the `listener` function to the *beginning* of the listeners array for the
@ -454,7 +454,7 @@ Returns a reference to the `EventEmitter`, so that calls can be chained.
added: v6.0.0 added: v6.0.0
--> -->
* `eventName` {String|Symbol} The name of the event. * `eventName` {string|symbol} The name of the event.
* `listener` {Function} The callback function * `listener` {Function} The callback function
Adds a **one time** `listener` function for the event named `eventName` to the Adds a **one time** `listener` function for the event named `eventName` to the

232
doc/api/fs.md
View File

@ -121,8 +121,8 @@ The object itself emits these events:
added: v0.5.8 added: v0.5.8
--> -->
* `eventType` {String} The type of fs change * `eventType` {string} The type of fs change
* `filename` {String | Buffer} The filename that changed (if relevant/available) * `filename` {string | Buffer} The filename that changed (if relevant/available)
Emitted when something changes in a watched directory or file. Emitted when something changes in a watched directory or file.
See more details in [`fs.watch()`][]. See more details in [`fs.watch()`][].
@ -317,7 +317,7 @@ argument to `fs.createWriteStream()`. If `path` is passed as a string, then
added: v0.11.15 added: v0.11.15
--> -->
* `path` {String | Buffer} * `path` {string | Buffer}
* `mode` {Integer} * `mode` {Integer}
* `callback` {Function} * `callback` {Function}
@ -438,7 +438,7 @@ process.
added: v0.11.15 added: v0.11.15
--> -->
* `path` {String | Buffer} * `path` {string | Buffer}
* `mode` {Integer} * `mode` {Integer}
Synchronous version of [`fs.access()`][]. This throws if any accessibility Synchronous version of [`fs.access()`][]. This throws if any accessibility
@ -449,12 +449,12 @@ checks fail, and does nothing otherwise.
added: v0.6.7 added: v0.6.7
--> -->
* `file` {String | Buffer | Number} filename or file descriptor * `file` {string | Buffer | Number} filename or file descriptor
* `data` {String | Buffer} * `data` {string | Buffer}
* `options` {Object | String} * `options` {Object | String}
* `encoding` {String | Null} default = `'utf8'` * `encoding` {string | Null} default = `'utf8'`
* `mode` {Integer} default = `0o666` * `mode` {Integer} default = `0o666`
* `flag` {String} default = `'a'` * `flag` {string} default = `'a'`
* `callback` {Function} * `callback` {Function}
Asynchronously append data to a file, creating the file if it does not yet exist. Asynchronously append data to a file, creating the file if it does not yet exist.
@ -485,12 +485,12 @@ automatically._
added: v0.6.7 added: v0.6.7
--> -->
* `file` {String | Buffer | Number} filename or file descriptor * `file` {string | Buffer | Number} filename or file descriptor
* `data` {String | Buffer} * `data` {string | Buffer}
* `options` {Object | String} * `options` {Object | String}
* `encoding` {String | Null} default = `'utf8'` * `encoding` {string | Null} default = `'utf8'`
* `mode` {Integer} default = `0o666` * `mode` {Integer} default = `0o666`
* `flag` {String} default = `'a'` * `flag` {string} default = `'a'`
The synchronous version of [`fs.appendFile()`][]. Returns `undefined`. The synchronous version of [`fs.appendFile()`][]. Returns `undefined`.
@ -499,7 +499,7 @@ The synchronous version of [`fs.appendFile()`][]. Returns `undefined`.
added: v0.1.30 added: v0.1.30
--> -->
* `path` {String | Buffer} * `path` {string | Buffer}
* `mode` {Integer} * `mode` {Integer}
* `callback` {Function} * `callback` {Function}
@ -511,7 +511,7 @@ to the completion callback.
added: v0.6.7 added: v0.6.7
--> -->
* `path` {String | Buffer} * `path` {string | Buffer}
* `mode` {Integer} * `mode` {Integer}
Synchronous chmod(2). Returns `undefined`. Synchronous chmod(2). Returns `undefined`.
@ -521,7 +521,7 @@ Synchronous chmod(2). Returns `undefined`.
added: v0.1.97 added: v0.1.97
--> -->
* `path` {String | Buffer} * `path` {string | Buffer}
* `uid` {Integer} * `uid` {Integer}
* `gid` {Integer} * `gid` {Integer}
* `callback` {Function} * `callback` {Function}
@ -534,7 +534,7 @@ to the completion callback.
added: v0.1.97 added: v0.1.97
--> -->
* `path` {String | Buffer} * `path` {string | Buffer}
* `uid` {Integer} * `uid` {Integer}
* `gid` {Integer} * `gid` {Integer}
@ -571,13 +571,13 @@ operations. The specific constants currently defined are described in
added: v0.1.31 added: v0.1.31
--> -->
* `path` {String | Buffer} * `path` {string | Buffer}
* `options` {String | Object} * `options` {string | Object}
* `flags` {String} * `flags` {string}
* `encoding` {String} * `encoding` {string}
* `fd` {Integer} * `fd` {Integer}
* `mode` {Integer} * `mode` {Integer}
* `autoClose` {Boolean} * `autoClose` {boolean}
* `start` {Integer} * `start` {Integer}
* `end` {Integer} * `end` {Integer}
@ -632,13 +632,13 @@ If `options` is a string, then it specifies the encoding.
added: v0.1.31 added: v0.1.31
--> -->
* `path` {String | Buffer} * `path` {string | Buffer}
* `options` {String | Object} * `options` {string | Object}
* `flags` {String} * `flags` {string}
* `defaultEncoding` {String} * `defaultEncoding` {string}
* `fd` {Integer} * `fd` {Integer}
* `mode` {Integer} * `mode` {Integer}
* `autoClose` {Boolean} * `autoClose` {boolean}
* `start` {Integer} * `start` {Integer}
Returns a new [`WriteStream`][] object. (See [Writable Stream][]). Returns a new [`WriteStream`][] object. (See [Writable Stream][]).
@ -682,7 +682,7 @@ deprecated: v1.0.0
> Stability: 0 - Deprecated: Use [`fs.stat()`][] or [`fs.access()`][] instead. > Stability: 0 - Deprecated: Use [`fs.stat()`][] or [`fs.access()`][] instead.
* `path` {String | Buffer} * `path` {string | Buffer}
* `callback` {Function} * `callback` {Function}
Test whether or not the given path exists by checking with the file system. Test whether or not the given path exists by checking with the file system.
@ -784,7 +784,7 @@ process.
added: v0.1.21 added: v0.1.21
--> -->
* `path` {String | Buffer} * `path` {string | Buffer}
Synchronous version of [`fs.exists()`][]. Synchronous version of [`fs.exists()`][].
Returns `true` if the file exists, `false` otherwise. Returns `true` if the file exists, `false` otherwise.
@ -993,7 +993,7 @@ Synchronous version of [`fs.futimes()`][]. Returns `undefined`.
deprecated: v0.4.7 deprecated: v0.4.7
--> -->
* `path` {String | Buffer} * `path` {string | Buffer}
* `mode` {Integer} * `mode` {Integer}
* `callback` {Function} * `callback` {Function}
@ -1007,7 +1007,7 @@ Only available on macOS.
deprecated: v0.4.7 deprecated: v0.4.7
--> -->
* `path` {String | Buffer} * `path` {string | Buffer}
* `mode` {Integer} * `mode` {Integer}
Synchronous lchmod(2). Returns `undefined`. Synchronous lchmod(2). Returns `undefined`.
@ -1017,7 +1017,7 @@ Synchronous lchmod(2). Returns `undefined`.
deprecated: v0.4.7 deprecated: v0.4.7
--> -->
* `path` {String | Buffer} * `path` {string | Buffer}
* `uid` {Integer} * `uid` {Integer}
* `gid` {Integer} * `gid` {Integer}
* `callback` {Function} * `callback` {Function}
@ -1030,7 +1030,7 @@ to the completion callback.
deprecated: v0.4.7 deprecated: v0.4.7
--> -->
* `path` {String | Buffer} * `path` {string | Buffer}
* `uid` {Integer} * `uid` {Integer}
* `gid` {Integer} * `gid` {Integer}
@ -1041,8 +1041,8 @@ Synchronous lchown(2). Returns `undefined`.
added: v0.1.31 added: v0.1.31
--> -->
* `existingPath` {String | Buffer} * `existingPath` {string | Buffer}
* `newPath` {String | Buffer} * `newPath` {string | Buffer}
* `callback` {Function} * `callback` {Function}
Asynchronous link(2). No arguments other than a possible exception are given to Asynchronous link(2). No arguments other than a possible exception are given to
@ -1053,8 +1053,8 @@ the completion callback.
added: v0.1.31 added: v0.1.31
--> -->
* `existingPath` {String | Buffer} * `existingPath` {string | Buffer}
* `newPath` {String | Buffer} * `newPath` {string | Buffer}
Synchronous link(2). Returns `undefined`. Synchronous link(2). Returns `undefined`.
@ -1063,7 +1063,7 @@ Synchronous link(2). Returns `undefined`.
added: v0.1.30 added: v0.1.30
--> -->
* `path` {String | Buffer} * `path` {string | Buffer}
* `callback` {Function} * `callback` {Function}
Asynchronous lstat(2). The callback gets two arguments `(err, stats)` where Asynchronous lstat(2). The callback gets two arguments `(err, stats)` where
@ -1076,7 +1076,7 @@ not the file that it refers to.
added: v0.1.30 added: v0.1.30
--> -->
* `path` {String | Buffer} * `path` {string | Buffer}
Synchronous lstat(2). Returns an instance of [`fs.Stats`][]. Synchronous lstat(2). Returns an instance of [`fs.Stats`][].
@ -1085,7 +1085,7 @@ Synchronous lstat(2). Returns an instance of [`fs.Stats`][].
added: v0.1.8 added: v0.1.8
--> -->
* `path` {String | Buffer} * `path` {string | Buffer}
* `mode` {Integer} * `mode` {Integer}
* `callback` {Function} * `callback` {Function}
@ -1097,7 +1097,7 @@ to the completion callback. `mode` defaults to `0o777`.
added: v0.1.21 added: v0.1.21
--> -->
* `path` {String | Buffer} * `path` {string | Buffer}
* `mode` {Integer} * `mode` {Integer}
Synchronous mkdir(2). Returns `undefined`. Synchronous mkdir(2). Returns `undefined`.
@ -1107,9 +1107,9 @@ Synchronous mkdir(2). Returns `undefined`.
added: v5.10.0 added: v5.10.0
--> -->
* `prefix` {String} * `prefix` {string}
* `options` {String | Object} * `options` {string | Object}
* `encoding` {String} default = `'utf8'` * `encoding` {string} default = `'utf8'`
* `callback` {Function} * `callback` {Function}
Creates a unique temporary directory. Creates a unique temporary directory.
@ -1169,9 +1169,9 @@ fs.mkdtemp(`${tmpDir}${sep}`, (err, folder) => {
added: v5.10.0 added: v5.10.0
--> -->
* `prefix` {String} * `prefix` {string}
* `options` {String | Object} * `options` {string | Object}
* `encoding` {String} default = `'utf8'` * `encoding` {string} default = `'utf8'`
The synchronous version of [`fs.mkdtemp()`][]. Returns the created The synchronous version of [`fs.mkdtemp()`][]. Returns the created
folder path. folder path.
@ -1184,8 +1184,8 @@ object with an `encoding` property specifying the character encoding to use.
added: v0.0.2 added: v0.0.2
--> -->
* `path` {String | Buffer} * `path` {string | Buffer}
* `flags` {String | Number} * `flags` {string | Number}
* `mode` {Integer} * `mode` {Integer}
* `callback` {Function} * `callback` {Function}
@ -1268,8 +1268,8 @@ fs.open('<directory>', 'a+', (err, fd) => {
added: v0.1.21 added: v0.1.21
--> -->
* `path` {String | Buffer} * `path` {string | Buffer}
* `flags` {String | Number} * `flags` {string | Number}
* `mode` {Integer} * `mode` {Integer}
Synchronous version of [`fs.open()`][]. Returns an integer representing the file Synchronous version of [`fs.open()`][]. Returns an integer representing the file
@ -1281,7 +1281,7 @@ added: v0.0.2
--> -->
* `fd` {Integer} * `fd` {Integer}
* `buffer` {String | Buffer} * `buffer` {string | Buffer}
* `offset` {Integer} * `offset` {Integer}
* `length` {Integer} * `length` {Integer}
* `position` {Integer} * `position` {Integer}
@ -1305,9 +1305,9 @@ The callback is given the three arguments, `(err, bytesRead, buffer)`.
added: v0.1.8 added: v0.1.8
--> -->
* `path` {String | Buffer} * `path` {string | Buffer}
* `options` {String | Object} * `options` {string | Object}
* `encoding` {String} default = `'utf8'` * `encoding` {string} default = `'utf8'`
* `callback` {Function} * `callback` {Function}
Asynchronous readdir(3). Reads the contents of a directory. Asynchronous readdir(3). Reads the contents of a directory.
@ -1324,9 +1324,9 @@ the filenames returned will be passed as `Buffer` objects.
added: v0.1.21 added: v0.1.21
--> -->
* `path` {String | Buffer} * `path` {string | Buffer}
* `options` {String | Object} * `options` {string | Object}
* `encoding` {String} default = `'utf8'` * `encoding` {string} default = `'utf8'`
Synchronous readdir(3). Returns an array of filenames excluding `'.'` and Synchronous readdir(3). Returns an array of filenames excluding `'.'` and
`'..'`. `'..'`.
@ -1341,10 +1341,10 @@ the filenames returned will be passed as `Buffer` objects.
added: v0.1.29 added: v0.1.29
--> -->
* `file` {String | Buffer | Integer} filename or file descriptor * `file` {string | Buffer | Integer} filename or file descriptor
* `options` {Object | String} * `options` {Object | String}
* `encoding` {String | Null} default = `null` * `encoding` {string | Null} default = `null`
* `flag` {String} default = `'r'` * `flag` {string} default = `'r'`
* `callback` {Function} * `callback` {Function}
Asynchronously reads the entire contents of a file. Example: Asynchronously reads the entire contents of a file. Example:
@ -1377,10 +1377,10 @@ automatically._
added: v0.1.8 added: v0.1.8
--> -->
* `file` {String | Buffer | Integer} filename or file descriptor * `file` {string | Buffer | Integer} filename or file descriptor
* `options` {Object | String} * `options` {Object | String}
* `encoding` {String | Null} default = `null` * `encoding` {string | Null} default = `null`
* `flag` {String} default = `'r'` * `flag` {string} default = `'r'`
Synchronous version of [`fs.readFile`][]. Returns the contents of the `file`. Synchronous version of [`fs.readFile`][]. Returns the contents of the `file`.
@ -1392,9 +1392,9 @@ string. Otherwise it returns a buffer.
added: v0.1.31 added: v0.1.31
--> -->
* `path` {String | Buffer} * `path` {string | Buffer}
* `options` {String | Object} * `options` {string | Object}
* `encoding` {String} default = `'utf8'` * `encoding` {string} default = `'utf8'`
* `callback` {Function} * `callback` {Function}
Asynchronous readlink(2). The callback gets two arguments `(err, Asynchronous readlink(2). The callback gets two arguments `(err,
@ -1410,9 +1410,9 @@ the link path returned will be passed as a `Buffer` object.
added: v0.1.31 added: v0.1.31
--> -->
* `path` {String | Buffer} * `path` {string | Buffer}
* `options` {String | Object} * `options` {string | Object}
* `encoding` {String} default = `'utf8'` * `encoding` {string} default = `'utf8'`
Synchronous readlink(2). Returns the symbolic link's string value. Synchronous readlink(2). Returns the symbolic link's string value.
@ -1427,7 +1427,7 @@ added: v0.1.21
--> -->
* `fd` {Integer} * `fd` {Integer}
* `buffer` {String | Buffer} * `buffer` {string | Buffer}
* `offset` {Integer} * `offset` {Integer}
* `length` {Integer} * `length` {Integer}
* `position` {Integer} * `position` {Integer}
@ -1439,9 +1439,9 @@ Synchronous version of [`fs.read()`][]. Returns the number of `bytesRead`.
added: v0.1.31 added: v0.1.31
--> -->
* `path` {String | Buffer} * `path` {string | Buffer}
* `options` {String | Object} * `options` {string | Object}
* `encoding` {String} default = `'utf8'` * `encoding` {string} default = `'utf8'`
* `callback` {Function} * `callback` {Function}
Asynchronous realpath(3). The `callback` gets two arguments `(err, Asynchronous realpath(3). The `callback` gets two arguments `(err,
@ -1459,9 +1459,9 @@ the path returned will be passed as a `Buffer` object.
added: v0.1.31 added: v0.1.31
--> -->
* `path` {String | Buffer}; * `path` {string | Buffer};
* `options` {String | Object} * `options` {string | Object}
* `encoding` {String} default = `'utf8'` * `encoding` {string} default = `'utf8'`
Synchronous realpath(3). Returns the resolved path. Synchronous realpath(3). Returns the resolved path.
@ -1477,8 +1477,8 @@ will be passed as a `Buffer` object.
added: v0.0.2 added: v0.0.2
--> -->
* `oldPath` {String | Buffer} * `oldPath` {string | Buffer}
* `newPath` {String | Buffer} * `newPath` {string | Buffer}
* `callback` {Function} * `callback` {Function}
Asynchronous rename(2). No arguments other than a possible exception are given Asynchronous rename(2). No arguments other than a possible exception are given
@ -1489,8 +1489,8 @@ to the completion callback.
added: v0.1.21 added: v0.1.21
--> -->
* `oldPath` {String | Buffer} * `oldPath` {string | Buffer}
* `newPath` {String | Buffer} * `newPath` {string | Buffer}
Synchronous rename(2). Returns `undefined`. Synchronous rename(2). Returns `undefined`.
@ -1499,7 +1499,7 @@ Synchronous rename(2). Returns `undefined`.
added: v0.0.2 added: v0.0.2
--> -->
* `path` {String | Buffer} * `path` {string | Buffer}
* `callback` {Function} * `callback` {Function}
Asynchronous rmdir(2). No arguments other than a possible exception are given Asynchronous rmdir(2). No arguments other than a possible exception are given
@ -1510,7 +1510,7 @@ to the completion callback.
added: v0.1.21 added: v0.1.21
--> -->
* `path` {String | Buffer} * `path` {string | Buffer}
Synchronous rmdir(2). Returns `undefined`. Synchronous rmdir(2). Returns `undefined`.
@ -1519,7 +1519,7 @@ Synchronous rmdir(2). Returns `undefined`.
added: v0.0.2 added: v0.0.2
--> -->
* `path` {String | Buffer} * `path` {string | Buffer}
* `callback` {Function} * `callback` {Function}
Asynchronous stat(2). The callback gets two arguments `(err, stats)` where Asynchronous stat(2). The callback gets two arguments `(err, stats)` where
@ -1540,7 +1540,7 @@ is recommended.
added: v0.1.21 added: v0.1.21
--> -->
* `path` {String | Buffer} * `path` {string | Buffer}
Synchronous stat(2). Returns an instance of [`fs.Stats`][]. Synchronous stat(2). Returns an instance of [`fs.Stats`][].
@ -1549,9 +1549,9 @@ Synchronous stat(2). Returns an instance of [`fs.Stats`][].
added: v0.1.31 added: v0.1.31
--> -->
* `target` {String | Buffer} * `target` {string | Buffer}
* `path` {String | Buffer} * `path` {string | Buffer}
* `type` {String} * `type` {string}
* `callback` {Function} * `callback` {Function}
Asynchronous symlink(2). No arguments other than a possible exception are given Asynchronous symlink(2). No arguments other than a possible exception are given
@ -1574,9 +1574,9 @@ It creates a symbolic link named "new-port" that points to "foo".
added: v0.1.31 added: v0.1.31
--> -->
* `target` {String | Buffer} * `target` {string | Buffer}
* `path` {String | Buffer} * `path` {string | Buffer}
* `type` {String} * `type` {string}
Synchronous symlink(2). Returns `undefined`. Synchronous symlink(2). Returns `undefined`.
@ -1585,7 +1585,7 @@ Synchronous symlink(2). Returns `undefined`.
added: v0.8.6 added: v0.8.6
--> -->
* `path` {String | Buffer} * `path` {string | Buffer}
* `len` {Integer} default = `0` * `len` {Integer} default = `0`
* `callback` {Function} * `callback` {Function}
@ -1598,7 +1598,7 @@ first argument. In this case, `fs.ftruncate()` is called.
added: v0.8.6 added: v0.8.6
--> -->
* `path` {String | Buffer} * `path` {string | Buffer}
* `len` {Integer} default = `0` * `len` {Integer} default = `0`
Synchronous truncate(2). Returns `undefined`. A file descriptor can also be Synchronous truncate(2). Returns `undefined`. A file descriptor can also be
@ -1609,7 +1609,7 @@ passed as the first argument. In this case, `fs.ftruncateSync()` is called.
added: v0.0.2 added: v0.0.2
--> -->
* `path` {String | Buffer} * `path` {string | Buffer}
* `callback` {Function} * `callback` {Function}
Asynchronous unlink(2). No arguments other than a possible exception are given Asynchronous unlink(2). No arguments other than a possible exception are given
@ -1620,7 +1620,7 @@ to the completion callback.
added: v0.1.21 added: v0.1.21
--> -->
* `path` {String | Buffer} * `path` {string | Buffer}
Synchronous unlink(2). Returns `undefined`. Synchronous unlink(2). Returns `undefined`.
@ -1629,7 +1629,7 @@ Synchronous unlink(2). Returns `undefined`.
added: v0.1.31 added: v0.1.31
--> -->
* `filename` {String | Buffer} * `filename` {string | Buffer}
* `listener` {Function} * `listener` {Function}
Stop watching for changes on `filename`. If `listener` is specified, only that Stop watching for changes on `filename`. If `listener` is specified, only that
@ -1648,7 +1648,7 @@ when possible._
added: v0.4.2 added: v0.4.2
--> -->
* `path` {String | Buffer} * `path` {string | Buffer}
* `atime` {Integer} * `atime` {Integer}
* `mtime` {Integer} * `mtime` {Integer}
* `callback` {Function} * `callback` {Function}
@ -1670,7 +1670,7 @@ follow these rules:
added: v0.4.2 added: v0.4.2
--> -->
* `path` {String | Buffer} * `path` {string | Buffer}
* `atime` {Integer} * `atime` {Integer}
* `mtime` {Integer} * `mtime` {Integer}
@ -1681,15 +1681,15 @@ Synchronous version of [`fs.utimes()`][]. Returns `undefined`.
added: v0.5.10 added: v0.5.10
--> -->
* `filename` {String | Buffer} * `filename` {string | Buffer}
* `options` {String | Object} * `options` {string | Object}
* `persistent` {Boolean} Indicates whether the process should continue to run * `persistent` {boolean} Indicates whether the process should continue to run
as long as files are being watched. default = `true` as long as files are being watched. default = `true`
* `recursive` {Boolean} Indicates whether all subdirectories should be * `recursive` {boolean} Indicates whether all subdirectories should be
watched, or only the current directory. The applies when a directory is watched, or only the current directory. The applies when a directory is
specified, and only on supported platforms (See [Caveats][]). default = specified, and only on supported platforms (See [Caveats][]). default =
`false` `false`
* `encoding` {String} Specifies the character encoding to be used for the * `encoding` {string} Specifies the character encoding to be used for the
filename passed to the listener. default = `'utf8'` filename passed to the listener. default = `'utf8'`
* `listener` {Function} * `listener` {Function}
@ -1784,9 +1784,9 @@ fs.watch('somedir', (eventType, filename) => {
added: v0.1.31 added: v0.1.31
--> -->
* `filename` {String | Buffer} * `filename` {string | Buffer}
* `options` {Object} * `options` {Object}
* `persistent` {Boolean} * `persistent` {boolean}
* `interval` {Integer} * `interval` {Integer}
* `listener` {Function} * `listener` {Function}
@ -1863,9 +1863,9 @@ added: v0.11.5
--> -->
* `fd` {Integer} * `fd` {Integer}
* `data` {String | Buffer} * `data` {string | Buffer}
* `position` {Integer} * `position` {Integer}
* `encoding` {String} * `encoding` {string}
* `callback` {Function} * `callback` {Function}
Write `data` to the file specified by `fd`. If `data` is not a Buffer instance Write `data` to the file specified by `fd`. If `data` is not a Buffer instance
@ -1898,12 +1898,12 @@ the end of the file.
added: v0.1.29 added: v0.1.29
--> -->
* `file` {String | Buffer | Integer} filename or file descriptor * `file` {string | Buffer | Integer} filename or file descriptor
* `data` {String | Buffer} * `data` {string | Buffer}
* `options` {Object | String} * `options` {Object | String}
* `encoding` {String | Null} default = `'utf8'` * `encoding` {string | Null} default = `'utf8'`
* `mode` {Integer} default = `0o666` * `mode` {Integer} default = `0o666`
* `flag` {String} default = `'w'` * `flag` {string} default = `'w'`
* `callback` {Function} * `callback` {Function}
Asynchronously writes data to a file, replacing the file if it already exists. Asynchronously writes data to a file, replacing the file if it already exists.
@ -1941,12 +1941,12 @@ automatically._
added: v0.1.29 added: v0.1.29
--> -->
* `file` {String | Buffer | Integer} filename or file descriptor * `file` {string | Buffer | Integer} filename or file descriptor
* `data` {String | Buffer} * `data` {string | Buffer}
* `options` {Object | String} * `options` {Object | String}
* `encoding` {String | Null} default = `'utf8'` * `encoding` {string | Null} default = `'utf8'`
* `mode` {Integer} default = `0o666` * `mode` {Integer} default = `0o666`
* `flag` {String} default = `'w'` * `flag` {string} default = `'w'`
The synchronous version of [`fs.writeFile()`][]. Returns `undefined`. The synchronous version of [`fs.writeFile()`][]. Returns `undefined`.
@ -1967,9 +1967,9 @@ added: v0.11.5
--> -->
* `fd` {Integer} * `fd` {Integer}
* `data` {String | Buffer} * `data` {string | Buffer}
* `position` {Integer} * `position` {Integer}
* `encoding` {String} * `encoding` {string}
Synchronous versions of [`fs.write()`][]. Returns the number of bytes written. Synchronous versions of [`fs.write()`][]. Returns the number of bytes written.

84
doc/api/http.md
View File

@ -110,16 +110,16 @@ added: v0.3.4
* `options` {Object} Set of configurable options to set on the agent. * `options` {Object} Set of configurable options to set on the agent.
Can have the following fields: Can have the following fields:
* `keepAlive` {Boolean} Keep sockets around even when there are no * `keepAlive` {boolean} Keep sockets around even when there are no
outstanding requests, so they can be used for future requests without outstanding requests, so they can be used for future requests without
having to reestablish a TCP connection. Default = `false` having to reestablish a TCP connection. Default = `false`
* `keepAliveMsecs` {Integer} When using the `keepAlive` option, specifies * `keepAliveMsecs` {Integer} When using the `keepAlive` option, specifies
the [initial delay](#net_socket_setkeepalive_enable_initialdelay) the [initial delay](#net_socket_setkeepalive_enable_initialdelay)
for TCP Keep-Alive packets. Ignored when the for TCP Keep-Alive packets. Ignored when the
`keepAlive` option is `false` or `undefined`. Default = `1000`. `keepAlive` option is `false` or `undefined`. Default = `1000`.
* `maxSockets` {Number} Maximum number of sockets to allow per * `maxSockets` {number} Maximum number of sockets to allow per
host. Default = `Infinity`. host. Default = `Infinity`.
* `maxFreeSockets` {Number} Maximum number of sockets to leave open * `maxFreeSockets` {number} Maximum number of sockets to leave open
in a free state. Only relevant if `keepAlive` is set to `true`. in a free state. Only relevant if `keepAlive` is set to `true`.
Default = `256`. Default = `256`.
@ -184,9 +184,9 @@ added: v0.11.4
--> -->
* `options` {Object} A set of options providing information for name generation * `options` {Object} A set of options providing information for name generation
* `host` {String} A domain name or IP address of the server to issue the request to * `host` {string} A domain name or IP address of the server to issue the request to
* `port` {Number} Port of remote server * `port` {number} Port of remote server
* `localAddress` {String} Local interface to bind for network connections * `localAddress` {string} Local interface to bind for network connections
when issuing the request when issuing the request
* Returns: {String} * Returns: {String}
@ -463,8 +463,8 @@ aborted, in milliseconds since 1 January 1970 00:00:00 UTC.
added: v0.1.90 added: v0.1.90
--> -->
* `data` {String | Buffer} * `data` {string | Buffer}
* `encoding` {String} * `encoding` {string}
* `callback` {Function} * `callback` {Function}
Finishes sending the request. If any parts of the body are Finishes sending the request. If any parts of the body are
@ -497,7 +497,7 @@ the optimization and kickstart the request.
added: v0.5.9 added: v0.5.9
--> -->
* `noDelay` {Boolean} * `noDelay` {boolean}
Once a socket is assigned to this request and is connected Once a socket is assigned to this request and is connected
[`socket.setNoDelay()`][] will be called. [`socket.setNoDelay()`][] will be called.
@ -507,8 +507,8 @@ Once a socket is assigned to this request and is connected
added: v0.5.9 added: v0.5.9
--> -->
* `enable` {Boolean} * `enable` {boolean}
* `initialDelay` {Number} * `initialDelay` {number}
Once a socket is assigned to this request and is connected Once a socket is assigned to this request and is connected
[`socket.setKeepAlive()`][] will be called. [`socket.setKeepAlive()`][] will be called.
@ -518,7 +518,7 @@ Once a socket is assigned to this request and is connected
added: v0.5.9 added: v0.5.9
--> -->
* `timeout` {Number} Milliseconds before a request is considered to be timed out. * `timeout` {number} Milliseconds before a request is considered to be timed out.
* `callback` {Function} Optional function to be called when a timeout occurs. Same as binding to the `timeout` event. * `callback` {Function} Optional function to be called when a timeout occurs. Same as binding to the `timeout` event.
Once a socket is assigned to this request and is connected Once a socket is assigned to this request and is connected
@ -531,8 +531,8 @@ Returns `request`.
added: v0.1.29 added: v0.1.29
--> -->
* `chunk` {String | Buffer} * `chunk` {string | Buffer}
* `encoding` {String} * `encoding` {string}
* `callback` {Function} * `callback` {Function}
Sends a chunk of the body. By calling this method Sends a chunk of the body. By calling this method
@ -731,7 +731,7 @@ subsequent call will *re-open* the server using the provided options.
added: v0.1.90 added: v0.1.90
--> -->
* `path` {String} * `path` {string}
* `callback` {Function} * `callback` {Function}
Start a UNIX socket server listening for connections on the given `path`. Start a UNIX socket server listening for connections on the given `path`.
@ -747,9 +747,9 @@ subsequent call will *re-open* the server using the provided options.
added: v0.1.90 added: v0.1.90
--> -->
* `port` {Number} * `port` {number}
* `hostname` {String} * `hostname` {string}
* `backlog` {Number} * `backlog` {number}
* `callback` {Function} * `callback` {Function}
Begin accepting connections on the specified `port` and `hostname`. If the Begin accepting connections on the specified `port` and `hostname`. If the
@ -797,7 +797,7 @@ no limit will be applied.
added: v0.9.12 added: v0.9.12
--> -->
* `msecs` {Number} * `msecs` {number}
* `callback` {Function} * `callback` {Function}
Sets the timeout value for sockets, and emits a `'timeout'` event on Sets the timeout value for sockets, and emits a `'timeout'` event on
@ -895,8 +895,8 @@ will result in a [`TypeError`][] being thrown.
added: v0.1.90 added: v0.1.90
--> -->
* `data` {String | Buffer} * `data` {string | Buffer}
* `encoding` {String} * `encoding` {string}
* `callback` {Function} * `callback` {Function}
This method signals to the server that all of the response headers and body This method signals to the server that all of the response headers and body
@ -924,7 +924,7 @@ as `false`. After [`response.end()`][] executes, the value will be `true`.
added: v0.4.0 added: v0.4.0
--> -->
* `name` {String} * `name` {string}
* Returns: {String} * Returns: {String}
Reads out a header that's already been queued but not sent to the client. Reads out a header that's already been queued but not sent to the client.
@ -950,7 +950,7 @@ Boolean (read-only). True if headers were sent, false otherwise.
added: v0.4.0 added: v0.4.0
--> -->
* `name` {String} * `name` {string}
Removes a header that's queued for implicit sending. Removes a header that's queued for implicit sending.
@ -978,8 +978,8 @@ in responses.
added: v0.4.0 added: v0.4.0
--> -->
* `name` {String} * `name` {string}
* `value` {String} * `value` {string}
Sets a single header value for implicit headers. If this header already exists Sets a single header value for implicit headers. If this header already exists
in the to-be-sent headers, its value will be replaced. Use an array of strings in the to-be-sent headers, its value will be replaced. Use an array of strings
@ -1019,7 +1019,7 @@ const server = http.createServer((req,res) => {
added: v0.9.12 added: v0.9.12
--> -->
* `msecs` {Number} * `msecs` {number}
* `callback` {Function} * `callback` {Function}
Sets the Socket's timeout value to `msecs`. If a callback is Sets the Socket's timeout value to `msecs`. If a callback is
@ -1080,8 +1080,8 @@ status message which was sent out.
added: v0.1.29 added: v0.1.29
--> -->
* `chunk` {String | Buffer} * `chunk` {string | Buffer}
* `encoding` {String} * `encoding` {string}
* `callback` {Function} * `callback` {Function}
* Returns: {Boolean} * Returns: {Boolean}
@ -1126,8 +1126,8 @@ the request body should be sent. See the [`'checkContinue'`][] event on `Server`
added: v0.1.30 added: v0.1.30
--> -->
* `statusCode` {Number} * `statusCode` {number}
* `statusMessage` {String} * `statusMessage` {string}
* `headers` {Object} * `headers` {Object}
Sends a response header to the request. The status code is a 3-digit HTTP Sends a response header to the request. The status code is a 3-digit HTTP
@ -1315,7 +1315,7 @@ received. Only populated at the `'end'` event.
added: v0.5.9 added: v0.5.9
--> -->
* `msecs` {Number} * `msecs` {number}
* `callback` {Function} * `callback` {Function}
Calls `message.connection.setTimeout(msecs, callback)`. Calls `message.connection.setTimeout(msecs, callback)`.
@ -1533,28 +1533,28 @@ added: v0.3.6
--> -->
* `options` {Object} * `options` {Object}
* `protocol` {String} Protocol to use. Defaults to `'http:'`. * `protocol` {string} Protocol to use. Defaults to `'http:'`.
* `host` {String} A domain name or IP address of the server to issue the * `host` {string} A domain name or IP address of the server to issue the
request to. Defaults to `'localhost'`. request to. Defaults to `'localhost'`.
* `hostname` {String} Alias for `host`. To support [`url.parse()`][], * `hostname` {string} Alias for `host`. To support [`url.parse()`][],
`hostname` is preferred over `host`. `hostname` is preferred over `host`.
* `family` {Number} IP address family to use when resolving `host` and * `family` {number} IP address family to use when resolving `host` and
`hostname`. Valid values are `4` or `6`. When unspecified, both IP v4 and `hostname`. Valid values are `4` or `6`. When unspecified, both IP v4 and
v6 will be used. v6 will be used.
* `port` {Number} Port of remote server. Defaults to 80. * `port` {number} Port of remote server. Defaults to 80.
* `localAddress` {String} Local interface to bind for network connections. * `localAddress` {string} Local interface to bind for network connections.
* `socketPath` {String} Unix Domain Socket (use one of host:port or * `socketPath` {string} Unix Domain Socket (use one of host:port or
socketPath). socketPath).
* `method` {String} A string specifying the HTTP request method. Defaults to * `method` {string} A string specifying the HTTP request method. Defaults to
`'GET'`. `'GET'`.
* `path` {String} Request path. Defaults to `'/'`. Should include query * `path` {string} Request path. Defaults to `'/'`. Should include query
string if any. E.G. `'/index.html?page=12'`. An exception is thrown when string if any. E.G. `'/index.html?page=12'`. An exception is thrown when
the request path contains illegal characters. Currently, only spaces are the request path contains illegal characters. Currently, only spaces are
rejected but that may change in the future. rejected but that may change in the future.
* `headers` {Object} An object containing request headers. * `headers` {Object} An object containing request headers.
* `auth` {String} Basic authentication i.e. `'user:password'` to compute an * `auth` {string} Basic authentication i.e. `'user:password'` to compute an
Authorization header. Authorization header.
* `agent` {http.Agent|Boolean} Controls [`Agent`][] behavior. Possible values: * `agent` {http.Agent|boolean} Controls [`Agent`][] behavior. Possible values:
* `undefined` (default): use [`http.globalAgent`][] for this host and port. * `undefined` (default): use [`http.globalAgent`][] for this host and port.
* `Agent` object: explicitly use the passed in `Agent`. * `Agent` object: explicitly use the passed in `Agent`.
* `false`: causes a new `Agent` with default values to be used. * `false`: causes a new `Agent` with default values to be used.

2
doc/api/modules.md
View File

@ -624,7 +624,7 @@ The module that first required this one.
added: v0.5.1 added: v0.5.1
--> -->
* `id` {String} * `id` {string}
* Returns: {Object} `module.exports` from the resolved module * Returns: {Object} `module.exports` from the resolved module
The `module.require` method provides a way to load a module as if The `module.require` method provides a way to load a module as if

26
doc/api/net.md
View File

@ -123,7 +123,7 @@ added: v0.5.10
--> -->
* `handle` {Object} * `handle` {Object}
* `backlog` {Number} * `backlog` {number}
* `callback` {Function} * `callback` {Function}
The `handle` object can be set to either a server or socket (anything The `handle` object can be set to either a server or socket (anything
@ -149,11 +149,11 @@ added: v0.11.14
--> -->
* `options` {Object} - Required. Supports the following properties: * `options` {Object} - Required. Supports the following properties:
* `port` {Number} - Optional. * `port` {number} - Optional.
* `host` {String} - Optional. * `host` {string} - Optional.
* `backlog` {Number} - Optional. * `backlog` {number} - Optional.
* `path` {String} - Optional. * `path` {string} - Optional.
* `exclusive` {Boolean} - Optional. * `exclusive` {boolean} - Optional.
* `callback` {Function} - Optional. * `callback` {Function} - Optional.
The `port`, `host`, and `backlog` properties of `options`, as well as the The `port`, `host`, and `backlog` properties of `options`, as well as the
@ -183,8 +183,8 @@ subsequent call will *re-open* the server using the provided options.
added: v0.1.90 added: v0.1.90
--> -->
* `path` {String} * `path` {string}
* `backlog` {Number} * `backlog` {number}
* `callback` {Function} * `callback` {Function}
Start a local socket server listening for connections on the given `path`. Start a local socket server listening for connections on the given `path`.
@ -343,7 +343,7 @@ About `allowHalfOpen`, refer to [`net.createServer()`][] and [`'end'`][] event.
added: v0.1.90 added: v0.1.90
--> -->
* `had_error` {Boolean} `true` if the socket had a transmission error. * `had_error` {boolean} `true` if the socket had a transmission error.
Emitted once the socket is fully closed. The argument `had_error` is a boolean Emitted once the socket is fully closed. The argument `had_error` is a boolean
which says if the socket was closed due to a transmission error. which says if the socket was closed due to a transmission error.
@ -410,10 +410,10 @@ added: v0.11.3
Emitted after resolving the hostname but before connecting. Emitted after resolving the hostname but before connecting.
Not applicable to UNIX sockets. Not applicable to UNIX sockets.
* `err` {Error|Null} The error object. See [`dns.lookup()`][]. * `err` {Error|null} The error object. See [`dns.lookup()`][].
* `address` {String} The IP address. * `address` {string} The IP address.
* `family` {String|Null} The address type. See [`dns.lookup()`][]. * `family` {string|null} The address type. See [`dns.lookup()`][].
* `host` {String} The hostname. * `host` {string} The hostname.
### Event: 'timeout' ### Event: 'timeout'
<!-- YAML <!-- YAML

12
doc/api/os.md
View File

@ -60,7 +60,7 @@ each CPU/core installed.
The properties included on each object include: The properties included on each object include:
* `model` {String} * `model` {string}
* `speed` {number} (in MHz) * `speed` {number} (in MHz)
* `times` {Object} * `times` {Object}
* `user` {number} The number of milliseconds the CPU has spent in user mode. * `user` {number} The number of milliseconds the CPU has spent in user mode.
@ -244,10 +244,10 @@ value is an array of objects that each describe an assigned network address.
The properties available on the assigned network address object include: The properties available on the assigned network address object include:
* `address` {String} The assigned IPv4 or IPv6 address * `address` {string} The assigned IPv4 or IPv6 address
* `netmask` {String} The IPv4 or IPv6 network mask * `netmask` {string} The IPv4 or IPv6 network mask
* `family` {String} Either `IPv4` or `IPv6` * `family` {string} Either `IPv4` or `IPv6`
* `mac` {String} The MAC address of the network interface * `mac` {string} The MAC address of the network interface
* `internal` {boolean} `true` if the network interface is a loopback or * `internal` {boolean} `true` if the network interface is a loopback or
similar interface that is not remotely accessible; otherwise `false` similar interface that is not remotely accessible; otherwise `false`
* `scopeid` {number} The numeric IPv6 scope ID (only specified when `family` * `scopeid` {number} The numeric IPv6 scope ID (only specified when `family`
@ -383,7 +383,7 @@ added: v6.0.0
--> -->
* `options` {Object} * `options` {Object}
* `encoding` {String} Character encoding used to interpret resulting strings. * `encoding` {string} Character encoding used to interpret resulting strings.
If `encoding` is set to `'buffer'`, the `username`, `shell`, and `homedir` If `encoding` is set to `'buffer'`, the `username`, `shell`, and `homedir`
values will be `Buffer` instances. (Default: 'utf8') values will be `Buffer` instances. (Default: 'utf8')
* Returns: {Object} * Returns: {Object}

42
doc/api/path.md
View File

@ -59,8 +59,8 @@ path.posix.basename('/tmp/myfile.html');
added: v0.1.25 added: v0.1.25
--> -->
* `path` {String} * `path` {string}
* `ext` {String} An optional file extension * `ext` {string} An optional file extension
* Returns: {String} * Returns: {String}
The `path.basename()` methods returns the last portion of a `path`, similar to The `path.basename()` methods returns the last portion of a `path`, similar to
@ -117,7 +117,7 @@ process.env.PATH.split(path.delimiter)
added: v0.1.16 added: v0.1.16
--> -->
* `path` {String} * `path` {string}
* Returns: {String} * Returns: {String}
The `path.dirname()` method returns the directory name of a `path`, similar to The `path.dirname()` method returns the directory name of a `path`, similar to
@ -138,7 +138,7 @@ A [`TypeError`][] is thrown if `path` is not a string.
added: v0.1.25 added: v0.1.25
--> -->
* `path` {String} * `path` {string}
* Returns: {String} * Returns: {String}
The `path.extname()` method returns the extension of the `path`, from the last The `path.extname()` method returns the extension of the `path`, from the last
@ -174,11 +174,11 @@ added: v0.11.15
--> -->
* `pathObject` {Object} * `pathObject` {Object}
* `dir` {String} * `dir` {string}
* `root` {String} * `root` {string}
* `base` {String} * `base` {string}
* `name` {String} * `name` {string}
* `ext` {String} * `ext` {string}
* Returns: {String} * Returns: {String}
The `path.format()` method returns a path string from an object. This is the The `path.format()` method returns a path string from an object. This is the
@ -237,7 +237,7 @@ path.format({
added: v0.11.2 added: v0.11.2
--> -->
* `path` {String} * `path` {string}
* Returns: {Boolean} * Returns: {Boolean}
The `path.isAbsolute()` method determines if `path` is an absolute path. The `path.isAbsolute()` method determines if `path` is an absolute path.
@ -272,7 +272,7 @@ A [`TypeError`][] is thrown if `path` is not a string.
added: v0.1.16 added: v0.1.16
--> -->
* `...paths` {String} A sequence of path segments * `...paths` {string} A sequence of path segments
* Returns: {String} * Returns: {String}
The `path.join()` method joins all given `path` segments together using the The `path.join()` method joins all given `path` segments together using the
@ -299,7 +299,7 @@ A [`TypeError`][] is thrown if any of the path segments is not a string.
added: v0.1.23 added: v0.1.23
--> -->
* `path` {String} * `path` {string}
* Returns: {String} * Returns: {String}
The `path.normalize()` method normalizes the given `path`, resolving `'..'` and The `path.normalize()` method normalizes the given `path`, resolving `'..'` and
@ -333,7 +333,7 @@ A [`TypeError`][] is thrown if `path` is not a string.
added: v0.11.15 added: v0.11.15
--> -->
* `path` {String} * `path` {string}
* Returns: {Object} * Returns: {Object}
The `path.parse()` method returns an object whose properties represent The `path.parse()` method returns an object whose properties represent
@ -342,11 +342,11 @@ see [`path.sep`][].
The returned object will have the following properties: The returned object will have the following properties:
* `root` {String} * `root` {string}
* `dir` {String} * `dir` {string}
* `base` {String} * `base` {string}
* `ext` {String} * `ext` {string}
* `name` {String} * `name` {string}
For example on POSIX: For example on POSIX:
@ -413,8 +413,8 @@ of the `path` methods.
added: v0.5.0 added: v0.5.0
--> -->
* `from` {String} * `from` {string}
* `to` {String} * `to` {string}
* Returns: {String} * Returns: {String}
The `path.relative()` method returns the relative path from `from` to `to`. The `path.relative()` method returns the relative path from `from` to `to`.
@ -445,7 +445,7 @@ A [`TypeError`][] is thrown if neither `from` nor `to` is a string.
added: v0.3.4 added: v0.3.4
--> -->
* `...paths` {String} A sequence of paths or path segments * `...paths` {string} A sequence of paths or path segments
* Returns: {String} * Returns: {String}
The `path.resolve()` method resolves a sequence of paths or path segments into The `path.resolve()` method resolves a sequence of paths or path segments into

32
doc/api/process.md
View File

@ -268,9 +268,9 @@ lead to sub-optimal application performance, bugs or security vulnerabilities.
The listener function is called with a single `warning` argument whose value is The listener function is called with a single `warning` argument whose value is
an `Error` object. There are three key properties that describe the warning: an `Error` object. There are three key properties that describe the warning:
* `name` {String} The name of the warning (currently `Warning` by default). * `name` {string} The name of the warning (currently `Warning` by default).
* `message` {String} A system-provided description of the warning. * `message` {string} A system-provided description of the warning.
* `stack` {String} A stack trace to the location in the code where the warning * `stack` {string} A stack trace to the location in the code where the warning
was issued. was issued.
```js ```js
@ -519,7 +519,7 @@ $ bash -c 'exec -a customArgv0 ./node'
added: v0.1.17 added: v0.1.17
--> -->
* `directory` {String} * `directory` {string}
The `process.chdir()` method changes the current working directory of the The `process.chdir()` method changes the current working directory of the
Node.js process or throws an exception if doing so fails (for instance, if Node.js process or throws an exception if doing so fails (for instance, if
@ -740,8 +740,8 @@ console.log(process.env.test);
added: v6.0.0 added: v6.0.0
--> -->
* `warning` {String | Error} The warning to emit. * `warning` {string | Error} The warning to emit.
* `name` {String} When `warning` is a String, `name` is the name to use * `name` {string} When `warning` is a String, `name` is the name to use
for the warning. Default: `Warning`. for the warning. Default: `Warning`.
* `ctor` {Function} When `warning` is a String, `ctor` is an optional * `ctor` {Function} When `warning` is a String, `ctor` is an optional
function used to limit the generated stack trace. Default function used to limit the generated stack trace. Default
@ -1080,8 +1080,8 @@ passing the result to process.hrtime() will result in undefined behavior.
added: v0.9.4 added: v0.9.4
--> -->
* `user` {String|number} The user name or numeric identifier. * `user` {string|number} The user name or numeric identifier.
* `extra_group` {String|number} A group name or numeric identifier. * `extra_group` {string|number} A group name or numeric identifier.
The `process.initgroups()` method reads the `/etc/group` file and initializes The `process.initgroups()` method reads the `/etc/group` file and initializes
the group access list, using all groups of which the user is a member. This is the group access list, using all groups of which the user is a member. This is
@ -1107,7 +1107,7 @@ added: v0.0.6
--> -->
* `pid` {number} A process ID * `pid` {number} A process ID
* `signal` {String|number} The signal to send, either as a string or number. * `signal` {string|number} The signal to send, either as a string or number.
Defaults to `'SIGTERM'`. Defaults to `'SIGTERM'`.
The `process.kill()` method sends the `signal` to the process identified by The `process.kill()` method sends the `signal` to the process identified by
@ -1325,7 +1325,7 @@ tarball.
`process.release` contains the following properties: `process.release` contains the following properties:
* `name` {String} A value that will always be `'node'` for Node.js. For * `name` {string} A value that will always be `'node'` for Node.js. For
legacy io.js releases, this will be `'io.js'`. legacy io.js releases, this will be `'io.js'`.
* `lts`: a string with a value indicating the _codename_ of the LTS (Long-term * `lts`: a string with a value indicating the _codename_ of the LTS (Long-term
Support) line the current release is part of. This property only exists for Support) line the current release is part of. This property only exists for
@ -1333,17 +1333,17 @@ tarball.
releases. Current valid values are: releases. Current valid values are:
- `"Argon"` for the v4.x LTS line beginning with v4.2.0. - `"Argon"` for the v4.x LTS line beginning with v4.2.0.
- `"Boron"` for the v6.x LTS line beginning with v6.9.0. - `"Boron"` for the v6.x LTS line beginning with v6.9.0.
* `sourceUrl` {String} an absolute URL pointing to a _`.tar.gz`_ file containing * `sourceUrl` {string} an absolute URL pointing to a _`.tar.gz`_ file containing
the source code of the current release. the source code of the current release.
* `headersUrl`{String} an absolute URL pointing to a _`.tar.gz`_ file containing * `headersUrl`{String} an absolute URL pointing to a _`.tar.gz`_ file containing
only the source header files for the current release. This file is only the source header files for the current release. This file is
significantly smaller than the full source file and can be used for compiling significantly smaller than the full source file and can be used for compiling
Node.js native add-ons. Node.js native add-ons.
* `libUrl` {String} an absolute URL pointing to a _`node.lib`_ file matching the * `libUrl` {string} an absolute URL pointing to a _`node.lib`_ file matching the
architecture and version of the current release. This file is used for architecture and version of the current release. This file is used for
compiling Node.js native add-ons. _This property is only present on Windows compiling Node.js native add-ons. _This property is only present on Windows
builds of Node.js and will be missing on all other platforms._ builds of Node.js and will be missing on all other platforms._
* `lts` {String} a string label identifying the [LTS][] label for this release. * `lts` {string} a string label identifying the [LTS][] label for this release.
If the Node.js release is not an LTS release, this will be `undefined`. If the Node.js release is not an LTS release, this will be `undefined`.
For example: For example:
@ -1388,7 +1388,7 @@ If Node.js was not spawned with an IPC channel, `process.send()` will be
added: v2.0.0 added: v2.0.0
--> -->
* `id` {String|number} A group name or ID * `id` {string|number} A group name or ID
The `process.setegid()` method sets the effective group identity of the process. The `process.setegid()` method sets the effective group identity of the process.
(See setegid(2).) The `id` can be passed as either a numeric ID or a group (See setegid(2).) The `id` can be passed as either a numeric ID or a group
@ -1417,7 +1417,7 @@ Android)
added: v2.0.0 added: v2.0.0
--> -->
* `id` {String|number} A user name or ID * `id` {string|number} A user name or ID
The `process.seteuid()` method sets the effective user identity of the process. The `process.seteuid()` method sets the effective user identity of the process.
(See seteuid(2).) The `id` can be passed as either a numeric ID or a username (See seteuid(2).) The `id` can be passed as either a numeric ID or a username
@ -1445,7 +1445,7 @@ Android)
added: v0.1.31 added: v0.1.31
--> -->
* `id` {String|number} The group name or ID * `id` {string|number} The group name or ID
The `process.setgid()` method sets the group identity of the process. (See The `process.setgid()` method sets the group identity of the process. (See
setgid(2).) The `id` can be passed as either a numeric ID or a group name setgid(2).) The `id` can be passed as either a numeric ID or a group name

10
doc/api/punycode.md
View File

@ -34,7 +34,7 @@ the module must be directed to the [Punycode.js][] project.
added: v0.5.1 added: v0.5.1
--> -->
* `string` {String} * `string` {string}
The `punycode.decode()` method converts a [Punycode][] string of ASCII-only The `punycode.decode()` method converts a [Punycode][] string of ASCII-only
characters to the equivalent string of Unicode codepoints. characters to the equivalent string of Unicode codepoints.
@ -49,7 +49,7 @@ punycode.decode('--dqo34k'); // '☃-⌘'
added: v0.5.1 added: v0.5.1
--> -->
* `string` {String} * `string` {string}
The `punycode.encode()` method converts a string of Unicode codepoints to a The `punycode.encode()` method converts a string of Unicode codepoints to a
[Punycode][] string of ASCII-only characters. [Punycode][] string of ASCII-only characters.
@ -64,7 +64,7 @@ punycode.encode('☃-⌘'); // '--dqo34k'
added: v0.6.1 added: v0.6.1
--> -->
* `domain` {String} * `domain` {string}
The `punycode.toASCII()` method converts a Unicode string representing an The `punycode.toASCII()` method converts a Unicode string representing an
Internationalized Domain Name to [Punycode][]. Only the non-ASCII parts of the Internationalized Domain Name to [Punycode][]. Only the non-ASCII parts of the
@ -83,7 +83,7 @@ punycode.toASCII('example.com'); // 'example.com'
added: v0.6.1 added: v0.6.1
--> -->
* `domain` {String} * `domain` {string}
The `punycode.toUnicode()` method converts a string representing a domain name The `punycode.toUnicode()` method converts a string representing a domain name
containing [Punycode][] encoded characters into Unicode. Only the [Punycode][] containing [Punycode][] encoded characters into Unicode. Only the [Punycode][]
@ -106,7 +106,7 @@ added: v0.7.0
added: v0.7.0 added: v0.7.0
--> -->
* `string` {String} * `string` {string}
The `punycode.ucs2.decode()` method returns an array containing the numeric The `punycode.ucs2.decode()` method returns an array containing the numeric
codepoint values of each Unicode symbol in the string. codepoint values of each Unicode symbol in the string.

14
doc/api/querystring.md
View File

@ -16,7 +16,7 @@ const querystring = require('querystring');
added: v0.1.25 added: v0.1.25
--> -->
* `str` {String} * `str` {string}
The `querystring.escape()` method performs URL percent-encoding on the given The `querystring.escape()` method performs URL percent-encoding on the given
`str` in a manner that is optimized for the specific requirements of URL `str` in a manner that is optimized for the specific requirements of URL
@ -32,10 +32,10 @@ necessary by assigning `querystring.escape` to an alternative function.
added: v0.1.25 added: v0.1.25
--> -->
* `str` {String} The URL query string to parse * `str` {string} The URL query string to parse
* `sep` {String} The substring used to delimit key and value pairs in the * `sep` {string} The substring used to delimit key and value pairs in the
query string. Defaults to `'&'`. query string. Defaults to `'&'`.
* `eq` {String}. The substring used to delimit keys and values in the * `eq` {string}. The substring used to delimit keys and values in the
query string. Defaults to `'='`. query string. Defaults to `'='`.
* `options` {Object} * `options` {Object}
* `decodeURIComponent` {Function} The function to use when decoding * `decodeURIComponent` {Function} The function to use when decoding
@ -79,9 +79,9 @@ added: v0.1.25
--> -->
* `obj` {Object} The object to serialize into a URL query string * `obj` {Object} The object to serialize into a URL query string
* `sep` {String} The substring used to delimit key and value pairs in the * `sep` {string} The substring used to delimit key and value pairs in the
query string. Defaults to `'&'`. query string. Defaults to `'&'`.
* `eq` {String}. The substring used to delimit keys and values in the * `eq` {string}. The substring used to delimit keys and values in the
query string. Defaults to `'='`. query string. Defaults to `'='`.
* `options` * `options`
* `encodeURIComponent` {Function} The function to use when converting * `encodeURIComponent` {Function} The function to use when converting
@ -121,7 +121,7 @@ querystring.stringify({ w: '中文', foo: 'bar' }, null, null,
<!-- YAML <!-- YAML
added: v0.1.25 added: v0.1.25
--> -->
* `str` {String} * `str` {string}
The `querystring.unescape()` method performs decoding of URL percent-encoded The `querystring.unescape()` method performs decoding of URL percent-encoded

10
doc/api/readline.md
View File

@ -237,7 +237,7 @@ If the `readline.Interface` was created with `output` set to `null` or
added: v0.3.3 added: v0.3.3
--> -->
* `query` {String} A statement or query to write to `output`, prepended to the * `query` {string} A statement or query to write to `output`, prepended to the
prompt. prompt.
* `callback` {Function} A callback function that is invoked with the user's * `callback` {Function} A callback function that is invoked with the user's
input in response to the `query`. input in response to the `query`.
@ -276,7 +276,7 @@ The `rl.resume()` method resumes the `input` stream if it has been paused.
added: v0.1.98 added: v0.1.98
--> -->
* `prompt` {String} * `prompt` {string}
The `rl.setPrompt()` method sets the prompt that will be written to `output` The `rl.setPrompt()` method sets the prompt that will be written to `output`
whenever `rl.prompt()` is called. whenever `rl.prompt()` is called.
@ -286,12 +286,12 @@ whenever `rl.prompt()` is called.
added: v0.1.98 added: v0.1.98
--> -->
* `data` {String} * `data` {string}
* `key` {Object} * `key` {Object}
* `ctrl` {boolean} `true` to indicate the `<ctrl>` key. * `ctrl` {boolean} `true` to indicate the `<ctrl>` key.
* `meta` {boolean} `true` to indicate the `<Meta>` key. * `meta` {boolean} `true` to indicate the `<Meta>` key.
* `shift` {boolean} `true` to indicate the `<Shift>` key. * `shift` {boolean} `true` to indicate the `<Shift>` key.
* `name` {String} The name of the a key. * `name` {string} The name of the a key.
The `rl.write()` method will write either `data` or a key sequence identified The `rl.write()` method will write either `data` or a key sequence identified
by `key` to the `output`. The `key` argument is supported only if `output` is by `key` to the `output`. The `key` argument is supported only if `output` is
@ -463,7 +463,7 @@ added: v0.7.7
* `stream` {Writable} * `stream` {Writable}
* `dx` {number} * `dx` {number}
* `dy` {Number} * `dy` {number}
The `readline.moveCursor()` method moves the cursor *relative* to its current The `readline.moveCursor()` method moves the cursor *relative* to its current
position in a given [TTY][] `stream`. position in a given [TTY][] `stream`.

8
doc/api/repl.md
View File

@ -304,7 +304,7 @@ Clearing context...
added: v0.3.0 added: v0.3.0
--> -->
* `keyword` {String} The command keyword (*without* a leading `.` character). * `keyword` {string} The command keyword (*without* a leading `.` character).
* `cmd` {Object|Function} The function to invoke when the command is processed. * `cmd` {Object|Function} The function to invoke when the command is processed.
The `replServer.defineCommand()` method is used to add new `.`-prefixed commands The `replServer.defineCommand()` method is used to add new `.`-prefixed commands
@ -312,7 +312,7 @@ to the REPL instance. Such commands are invoked by typing a `.` followed by the
`keyword`. The `cmd` is either a Function or an object with the following `keyword`. The `cmd` is either a Function or an object with the following
properties: properties:
* `help` {String} Help text to be displayed when `.help` is entered (Optional). * `help` {string} Help text to be displayed when `.help` is entered (Optional).
* `action` {Function} The function to execute, optionally accepting a single * `action` {Function} The function to execute, optionally accepting a single
string argument. string argument.
@ -351,7 +351,7 @@ Goodbye!
added: v0.1.91 added: v0.1.91
--> -->
* `preserveCursor` {Boolean} * `preserveCursor` {boolean}
The `replServer.displayPrompt()` method readies the REPL instance for input The `replServer.displayPrompt()` method readies the REPL instance for input
from the user, printing the configured `prompt` to a new line in the `output` from the user, printing the configured `prompt` to a new line in the `output`
@ -372,7 +372,7 @@ added: v0.1.91
--> -->
* `options` {Object | String} * `options` {Object | String}
* `prompt` {String} The input prompt to display. Defaults to `> `. * `prompt` {string} The input prompt to display. Defaults to `> `.
* `input` {Readable} The Readable stream from which REPL input will be read. * `input` {Readable} The Readable stream from which REPL input will be read.
Defaults to `process.stdin`. Defaults to `process.stdin`.
* `output` {Writable} The Writable stream to which REPL output will be * `output` {Writable} The Writable stream to which REPL output will be

54
doc/api/stream.md
View File

@ -354,10 +354,10 @@ See also: [`writable.uncork()`][].
added: v0.9.4 added: v0.9.4
--> -->
* `chunk` {String|Buffer|any} Optional data to write. For streams not operating * `chunk` {string|Buffer|any} Optional data to write. For streams not operating
in object mode, `chunk` must be a string or a `Buffer`. For object mode in object mode, `chunk` must be a string or a `Buffer`. For object mode
streams, `chunk` may be any JavaScript value other than `null`. streams, `chunk` may be any JavaScript value other than `null`.
* `encoding` {String} The encoding, if `chunk` is a String * `encoding` {string} The encoding, if `chunk` is a String
* `callback` {Function} Optional callback for when the stream is finished * `callback` {Function} Optional callback for when the stream is finished
Calling the `writable.end()` method signals that no more data will be written Calling the `writable.end()` method signals that no more data will be written
@ -382,7 +382,7 @@ file.end('world!');
added: v0.11.15 added: v0.11.15
--> -->
* `encoding` {String} The new default encoding * `encoding` {string} The new default encoding
* Returns: `this` * Returns: `this`
The `writable.setDefaultEncoding()` method sets the default `encoding` for a The `writable.setDefaultEncoding()` method sets the default `encoding` for a
@ -431,8 +431,8 @@ See also: [`writable.cork()`][].
added: v0.9.4 added: v0.9.4
--> -->
* `chunk` {String|Buffer} The data to write * `chunk` {string|Buffer} The data to write
* `encoding` {String} The encoding, if `chunk` is a String * `encoding` {string} The encoding, if `chunk` is a String
* `callback` {Function} Callback for when this chunk of data is flushed * `callback` {Function} Callback for when this chunk of data is flushed
* Returns: {Boolean} `false` if the stream wishes for the calling code to * Returns: {Boolean} `false` if the stream wishes for the calling code to
wait for the `'drain'` event to be emitted before continuing to write wait for the `'drain'` event to be emitted before continuing to write
@ -616,7 +616,7 @@ Not all [Readable][] streams will emit the `'close'` event.
added: v0.9.4 added: v0.9.4
--> -->
* `chunk` {Buffer|String|any} The chunk of data. For streams that are not * `chunk` {Buffer|string|any} The chunk of data. For streams that are not
operating in object mode, the chunk will be either a string or `Buffer`. operating in object mode, the chunk will be either a string or `Buffer`.
For streams that are in object mode, the chunk can be any JavaScript value For streams that are in object mode, the chunk can be any JavaScript value
other than `null`. other than `null`.
@ -780,7 +780,7 @@ added: v0.9.4
* `destination` {stream.Writable} The destination for writing data * `destination` {stream.Writable} The destination for writing data
* `options` {Object} Pipe options * `options` {Object} Pipe options
* `end` {Boolean} End the writer when the reader ends. Defaults to `true`. * `end` {boolean} End the writer when the reader ends. Defaults to `true`.
The `readable.pipe()` method attaches a [Writable][] stream to the `readable`, The `readable.pipe()` method attaches a [Writable][] stream to the `readable`,
causing it to switch automatically into flowing mode and push all of its data causing it to switch automatically into flowing mode and push all of its data
@ -836,8 +836,8 @@ options.
added: v0.9.4 added: v0.9.4
--> -->
* `size` {Number} Optional argument to specify how much data to read. * `size` {number} Optional argument to specify how much data to read.
* Return {String|Buffer|Null} * Return {String|Buffer|null}
The `readable.read()` method pulls some data out of the internal buffer and The `readable.read()` method pulls some data out of the internal buffer and
returns it. If no data available to be read, `null` is returned. By default, returns it. If no data available to be read, `null` is returned. By default,
@ -908,7 +908,7 @@ getReadableStreamSomehow()
added: v0.9.4 added: v0.9.4
--> -->
* `encoding` {String} The encoding to use. * `encoding` {string} The encoding to use.
* Returns: `this` * Returns: `this`
The `readable.setEncoding()` method sets the default character encoding for The `readable.setEncoding()` method sets the default character encoding for
@ -972,7 +972,7 @@ setTimeout(() => {
added: v0.9.11 added: v0.9.11
--> -->
* `chunk` {Buffer|String} Chunk of data to unshift onto the read queue * `chunk` {Buffer|string} Chunk of data to unshift onto the read queue
The `readable.unshift()` method pushes a chunk of data back into the internal The `readable.unshift()` method pushes a chunk of data back into the internal
buffer. This is useful in certain situations where a stream is being consumed by buffer. This is useful in certain situations where a stream is being consumed by
@ -1219,13 +1219,13 @@ constructor and implement the `writable._write()` method. The
#### Constructor: new stream.Writable([options]) #### Constructor: new stream.Writable([options])
* `options` {Object} * `options` {Object}
* `highWaterMark` {Number} Buffer level when * `highWaterMark` {number} Buffer level when
[`stream.write()`][stream-write] starts returning `false`. Defaults to [`stream.write()`][stream-write] starts returning `false`. Defaults to
`16384` (16kb), or `16` for `objectMode` streams. `16384` (16kb), or `16` for `objectMode` streams.
* `decodeStrings` {Boolean} Whether or not to decode strings into * `decodeStrings` {boolean} Whether or not to decode strings into
Buffers before passing them to [`stream._write()`][stream-_write]. Buffers before passing them to [`stream._write()`][stream-_write].
Defaults to `true` Defaults to `true`
* `objectMode` {Boolean} Whether or not the * `objectMode` {boolean} Whether or not the
[`stream.write(anyObj)`][stream-write] is a valid operation. When set, [`stream.write(anyObj)`][stream-write] is a valid operation. When set,
it becomes possible to write JavaScript values other than string or it becomes possible to write JavaScript values other than string or
`Buffer` if supported by the stream implementation. Defaults to `false` `Buffer` if supported by the stream implementation. Defaults to `false`
@ -1278,9 +1278,9 @@ const myWritable = new Writable({
#### writable.\_write(chunk, encoding, callback) #### writable.\_write(chunk, encoding, callback)
* `chunk` {Buffer|String} The chunk to be written. Will **always** * `chunk` {Buffer|string} The chunk to be written. Will **always**
be a buffer unless the `decodeStrings` option was set to `false`. be a buffer unless the `decodeStrings` option was set to `false`.
* `encoding` {String} If the chunk is a string, then `encoding` is the * `encoding` {string} If the chunk is a string, then `encoding` is the
character encoding of that string. If chunk is a `Buffer`, or if the character encoding of that string. If chunk is a `Buffer`, or if the
stream is operating in object mode, `encoding` may be ignored. stream is operating in object mode, `encoding` may be ignored.
* `callback` {Function} Call this function (optionally with an error * `callback` {Function} Call this function (optionally with an error
@ -1400,12 +1400,12 @@ constructor and implement the `readable._read()` method.
#### new stream.Readable([options]) #### new stream.Readable([options])
* `options` {Object} * `options` {Object}
* `highWaterMark` {Number} The maximum number of bytes to store in * `highWaterMark` {number} The maximum number of bytes to store in
the internal buffer before ceasing to read from the underlying the internal buffer before ceasing to read from the underlying
resource. Defaults to `16384` (16kb), or `16` for `objectMode` streams resource. Defaults to `16384` (16kb), or `16` for `objectMode` streams
* `encoding` {String} If specified, then buffers will be decoded to * `encoding` {string} If specified, then buffers will be decoded to
strings using the specified encoding. Defaults to `null` strings using the specified encoding. Defaults to `null`
* `objectMode` {Boolean} Whether this stream should behave * `objectMode` {boolean} Whether this stream should behave
as a stream of objects. Meaning that [`stream.read(n)`][stream-read] returns as a stream of objects. Meaning that [`stream.read(n)`][stream-read] returns
a single value instead of a Buffer of size n. Defaults to `false` a single value instead of a Buffer of size n. Defaults to `false`
* `read` {Function} Implementation for the [`stream._read()`][stream-_read] * `read` {Function} Implementation for the [`stream._read()`][stream-_read]
@ -1452,7 +1452,7 @@ const myReadable = new Readable({
#### readable.\_read(size) #### readable.\_read(size)
* `size` {Number} Number of bytes to read asynchronously * `size` {number} Number of bytes to read asynchronously
*Note*: **This function MUST NOT be called by application code directly.** It *Note*: **This function MUST NOT be called by application code directly.** It
should be implemented by child classes, and called only by the internal Readable should be implemented by child classes, and called only by the internal Readable
@ -1483,8 +1483,8 @@ user programs.
#### readable.push(chunk[, encoding]) #### readable.push(chunk[, encoding])
* `chunk` {Buffer|Null|String} Chunk of data to push into the read queue * `chunk` {Buffer|null|string} Chunk of data to push into the read queue
* `encoding` {String} Encoding of String chunks. Must be a valid * `encoding` {string} Encoding of String chunks. Must be a valid
Buffer encoding, such as `'utf8'` or `'ascii'` Buffer encoding, such as `'utf8'` or `'ascii'`
* Returns {Boolean} `true` if additional chunks of data may continued to be * Returns {Boolean} `true` if additional chunks of data may continued to be
pushed; `false` otherwise. pushed; `false` otherwise.
@ -1615,13 +1615,13 @@ constructor and implement *both* the `readable._read()` and
* `options` {Object} Passed to both Writable and Readable * `options` {Object} Passed to both Writable and Readable
constructors. Also has the following fields: constructors. Also has the following fields:
* `allowHalfOpen` {Boolean} Defaults to `true`. If set to `false`, then * `allowHalfOpen` {boolean} Defaults to `true`. If set to `false`, then
the stream will automatically end the readable side when the the stream will automatically end the readable side when the
writable side ends and vice versa. writable side ends and vice versa.
* `readableObjectMode` {Boolean} Defaults to `false`. Sets `objectMode` * `readableObjectMode` {boolean} Defaults to `false`. Sets `objectMode`
for readable side of the stream. Has no effect if `objectMode` for readable side of the stream. Has no effect if `objectMode`
is `true`. is `true`.
* `writableObjectMode` {Boolean} Defaults to `false`. Sets `objectMode` * `writableObjectMode` {boolean} Defaults to `false`. Sets `objectMode`
for writable side of the stream. Has no effect if `objectMode` for writable side of the stream. Has no effect if `objectMode`
is `true`. is `true`.
@ -1857,9 +1857,9 @@ user programs.
#### transform.\_transform(chunk, encoding, callback) #### transform.\_transform(chunk, encoding, callback)
* `chunk` {Buffer|String} The chunk to be transformed. Will **always** * `chunk` {Buffer|string} The chunk to be transformed. Will **always**
be a buffer unless the `decodeStrings` option was set to `false`. be a buffer unless the `decodeStrings` option was set to `false`.
* `encoding` {String} If the chunk is a string, then this is the * `encoding` {string} If the chunk is a string, then this is the
encoding type. If chunk is a buffer, then this is the special encoding type. If chunk is a buffer, then this is the special
value - 'buffer', ignore it in this case. value - 'buffer', ignore it in this case.
* `callback` {Function} A callback function (optionally with an error * `callback` {Function} A callback function (optionally with an error

54
doc/api/url.md
View File

@ -136,7 +136,7 @@ For example: `'#hash'`
added: v0.1.25 added: v0.1.25
--> -->
* `urlObject` {Object | String} A URL object (as returned by `url.parse()` or * `urlObject` {Object | string} A URL object (as returned by `url.parse()` or
constructed otherwise). If a string, it is converted to an object by passing constructed otherwise). If a string, it is converted to an object by passing
it to `url.parse()`. it to `url.parse()`.
@ -198,18 +198,59 @@ The formatting process operates as follows:
string, an [`Error`][] is thrown. string, an [`Error`][] is thrown.
* `result` is returned. * `result` is returned.
## url.format(URL[, options])
> Stability: 1 - Experimental
* `URL` {URL} A [WHATWG URL][] object
* `options` {Object}
* `auth` {boolean} `true` if the serialized URL string should include the
username and password, `false` otherwise. Defaults to `true`.
* `fragment` {boolean} `true` if the serialized URL string should include the
fragment, `false` otherwise. Defaults to `true`.
* `search` {boolean} `true` if the serialized URL string should include the
search query, `false` otherwise. Defaults to `true`.
* `unicode` {boolean} `true` if Unicode characters appearing in the host
component of the URL string should be encoded directly as opposed to being
Punycode encoded. Defaults to `false`.
Returns a customizable serialization of a URL String representation of a
[WHATWG URL][] object.
The URL object has both a `toString()` method and `href` property that return
string serializations of the URL. These are not, however, customizable in
any way. The `url.format(URL[, options])` method allows for basic customization
of the output.
For example:
```js
const myURL = new URL('https://a:b@你好你好?abc#foo');
console.log(myURL.href);
// Prints https://a:b@xn--6qqa088eba/?abc#foo
console.log(myURL.toString());
// Prints https://a:b@xn--6qqa088eba/?abc#foo
console.log(url.format(myURL, {fragment: false, unicode: true, auth: false}));
// Prints 'https://你好你好?abc'
```
*Note*: This variation of the `url.format()` method is currently considered to
be experimental.
## url.parse(urlString[, parseQueryString[, slashesDenoteHost]]) ## url.parse(urlString[, parseQueryString[, slashesDenoteHost]])
<!-- YAML <!-- YAML
added: v0.1.25 added: v0.1.25
--> -->
* `urlString` {String} The URL string to parse. * `urlString` {string} The URL string to parse.
* `parseQueryString` {Boolean} If `true`, the `query` property will always * `parseQueryString` {boolean} If `true`, the `query` property will always
be set to an object returned by the [`querystring`][] module's `parse()` be set to an object returned by the [`querystring`][] module's `parse()`
method. If `false`, the `query` property on the returned URL object will be an method. If `false`, the `query` property on the returned URL object will be an
unparsed, undecoded string. Defaults to `false`. unparsed, undecoded string. Defaults to `false`.
* `slashesDenoteHost` {Boolean} If `true`, the first token after the literal * `slashesDenoteHost` {boolean} If `true`, the first token after the literal
string `//` and preceding the next `/` will be interpreted as the `host`. string `//` and preceding the next `/` will be interpreted as the `host`.
For instance, given `//foo/bar`, the result would be For instance, given `//foo/bar`, the result would be
`{host: 'foo', pathname: '/bar'}` rather than `{pathname: '//foo/bar'}`. `{host: 'foo', pathname: '/bar'}` rather than `{pathname: '//foo/bar'}`.
@ -223,8 +264,8 @@ object.
added: v0.1.25 added: v0.1.25
--> -->
* `from` {String} The Base URL being resolved against. * `from` {string} The Base URL being resolved against.
* `to` {String} The HREF URL being resolved. * `to` {string} The HREF URL being resolved.
The `url.resolve()` method resolves a target URL relative to a base URL in a The `url.resolve()` method resolves a target URL relative to a base URL in a
manner similar to that of a Web browser resolving an anchor tag HREF. manner similar to that of a Web browser resolving an anchor tag HREF.
@ -250,7 +291,6 @@ properties of URL objects:
For example, the ASCII space character (`' '`) is encoded as `%20`. The ASCII For example, the ASCII space character (`' '`) is encoded as `%20`. The ASCII
forward slash (`/`) character is encoded as `%3C`. forward slash (`/`) character is encoded as `%3C`.
[`Error`]: errors.html#errors_class_error [`Error`]: errors.html#errors_class_error
[`querystring`]: querystring.html [`querystring`]: querystring.html
[`TypeError`]: errors.html#errors_class_typeerror [`TypeError`]: errors.html#errors_class_typeerror

10
doc/api/util.md
View File

@ -15,7 +15,7 @@ const util = require('util');
added: v0.11.3 added: v0.11.3
--> -->
* `section` {String} A string identifying the portion of the application for * `section` {string} A string identifying the portion of the application for
which the `debuglog` function is being created. which the `debuglog` function is being created.
* Returns: {Function} The logging function * Returns: {Function} The logging function
@ -93,7 +93,7 @@ property take precedence over `--trace-deprecation` and
added: v0.5.3 added: v0.5.3
--> -->
* `format` {String} A `printf`-like format string. * `format` {string} A `printf`-like format string.
The `util.format()` method returns a formatted string using the first argument The `util.format()` method returns a formatted string using the first argument
as a `printf`-like format. as a `printf`-like format.
@ -391,7 +391,7 @@ deprecated: v0.11.3
> Stability: 0 - Deprecated: Use [`console.error()`][] instead. > Stability: 0 - Deprecated: Use [`console.error()`][] instead.
* `string` {String} The message to print to `stderr` * `string` {string} The message to print to `stderr`
Deprecated predecessor of `console.error`. Deprecated predecessor of `console.error`.
@ -403,7 +403,7 @@ deprecated: v0.11.3
> Stability: 0 - Deprecated: Use [`console.error()`][] instead. > Stability: 0 - Deprecated: Use [`console.error()`][] instead.
* `...strings` {String} The message to print to `stderr` * `...strings` {string} The message to print to `stderr`
Deprecated predecessor of `console.error`. Deprecated predecessor of `console.error`.
@ -805,7 +805,7 @@ deprecated: v6.0.0
> Stability: 0 - Deprecated: Use a third party module instead. > Stability: 0 - Deprecated: Use a third party module instead.
* `string` {String} * `string` {string}
The `util.log()` method prints the given `string` to `stdout` with an included The `util.log()` method prints the given `string` to `stdout` with an included
timestamp. timestamp.

Write Preview
Loading…
Cancel
Save