Skip to content
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Wrap line at 80 columns
  • Loading branch information
matejkrajcovic committed Oct 30, 2017
commit 87e0226ff2e8cfa34e0aded756896eff15ec7e90
81 changes: 54 additions & 27 deletions doc/api/buffer.md
Original file line number Diff line number Diff line change
Expand Up @@ -1082,8 +1082,10 @@ added: v0.5.0
-->

* `value` {string|Buffer|integer} The value to fill `buf` with.
* `offset` {integer} Number of bytes to skip before starting to fill `buf`. **Default:** `0`
* `end` {integer} Where to stop filling `buf` (not inclusive). **Default:** [`buf.length`]
* `offset` {integer} Number of bytes to skip before starting to fill `buf`.
**Default:** `0`
* `end` {integer} Where to stop filling `buf` (not inclusive).
**Default:** [`buf.length`]
* `encoding` {string} If `value` is a string, this is its encoding.
**Default:** `'utf8'`
* Returns: {Buffer} A reference to `buf`.
Expand Down Expand Up @@ -1431,7 +1433,8 @@ console.log(buf.length);
added: v0.11.15
-->

* `offset` {integer} Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - 8`.
* `offset` {integer} Number of bytes to skip before starting to read.
Must satisfy: `0 <= offset <= buf.length - 8`.
* `noAssert` {boolean} Skip `offset` validation? **Default:** `false`
* Returns: {number}

Expand Down Expand Up @@ -1467,7 +1470,8 @@ console.log(buf.readDoubleLE(1, true));
added: v0.11.15
-->

* `offset` {integer} Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - 4`.
* `offset` {integer} Number of bytes to skip before starting to read.
Must satisfy: `0 <= offset <= buf.length - 4`.
* `noAssert` {boolean} Skip `offset` validation? **Default:** `false`
* Returns: {number}

Expand Down Expand Up @@ -1502,7 +1506,8 @@ console.log(buf.readFloatLE(1, true));
added: v0.5.0
-->

* `offset` {integer} Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - 1`.
* `offset` {integer} Number of bytes to skip before starting to read.
Must satisfy: `0 <= offset <= buf.length - 1`.
* `noAssert` {boolean} Skip `offset` validation? **Default:** `false`
* Returns: {integer}

Expand Down Expand Up @@ -1534,7 +1539,8 @@ console.log(buf.readInt8(2));
added: v0.5.5
-->

* `offset` {integer} Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - 2`.
* `offset` {integer} Number of bytes to skip before starting to read.
Must satisfy: `0 <= offset <= buf.length - 2`.
* `noAssert` {boolean} Skip `offset` validation? **Default:** `false`
* Returns: {integer}

Expand Down Expand Up @@ -1568,7 +1574,8 @@ console.log(buf.readInt16LE(1));
added: v0.5.5
-->

* `offset` {integer} Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - 4`.
* `offset` {integer} Number of bytes to skip before starting to read.
Must satisfy: `0 <= offset <= buf.length - 4`.
* `noAssert` {boolean} Skip `offset` validation? **Default:** `false`
* Returns: {integer}

Expand Down Expand Up @@ -1602,9 +1609,12 @@ console.log(buf.readInt32LE(1));
added: v0.11.15
-->

* `offset` {integer} Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - byteLength`.
* `byteLength` {integer} Number of bytes to read. Must satisfy: `0 < byteLength <= 6`.
* `noAssert` {boolean} Skip `offset` and `byteLength` validation? **Default:** `false`.
* `offset` {integer} Number of bytes to skip before starting to read.
Must satisfy: `0 <= offset <= buf.length - byteLength`.
* `byteLength` {integer} Number of bytes to read. Must satisfy:
`0 < byteLength <= 6`.
* `noAssert` {boolean} Skip `offset` and `byteLength` validation?
**Default:** `false`.
* Returns: {integer}

Reads `byteLength` number of bytes from `buf` at the specified `offset`
Expand Down Expand Up @@ -1664,7 +1674,8 @@ console.log(buf.readUInt8(2));
added: v0.5.5
-->

* `offset` {integer} Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - 2`.
* `offset` {integer} Number of bytes to skip before starting to read.
Must satisfy: `0 <= offset <= buf.length - 2`.
* `noAssert` {boolean} Skip `offset` validation? **Default:** `false`
* Returns: {integer}

Expand Down Expand Up @@ -1702,7 +1713,8 @@ console.log(buf.readUInt16LE(2).toString(16));
added: v0.5.5
-->

* `offset` {integer} Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - 4`.
* `offset` {integer} Number of bytes to skip before starting to read.
Must satisfy: `0 <= offset <= buf.length - 4`.
* `noAssert` {boolean} Skip `offset` validation? **Default:** `false`
* Returns: {integer}

Expand Down Expand Up @@ -1734,9 +1746,12 @@ console.log(buf.readUInt32LE(1).toString(16));
added: v0.11.15
-->

* `offset` {integer} Number of bytes to skip before starting to read. Must satisfy: `0 <= offset <= buf.length - byteLength`.
* `byteLength` {integer} Number of bytes to read. Must satisfy: `0 < byteLength <= 6`.
* `noAssert` {boolean} Skip `offset` and `byteLength` validation? **Default:** `false`
* `offset` {integer} Number of bytes to skip before starting to read.
Must satisfy: `0 <= offset <= buf.length - byteLength`.
* `byteLength` {integer} Number of bytes to read. Must satisfy:
`0 < byteLength <= 6`.
* `noAssert` {boolean} Skip `offset` and `byteLength` validation?
**Default:** `false`
* Returns: {integer}

Reads `byteLength` number of bytes from `buf` at the specified `offset`
Expand Down Expand Up @@ -2029,7 +2044,8 @@ added: v0.1.90
-->

* `string` {string} String to be written to `buf`.
* `offset` {integer} Number of bytes to skip before starting to write `string`. **Default:** `0`
* `offset` {integer} Number of bytes to skip before starting to write `string`.
**Default:** `0`
* `length` {integer} Number of bytes to write. **Default:** `buf.length - offset`
* `encoding` {string} The character encoding of `string`. **Default:** `'utf8'`
* Returns: {integer} Number of bytes written.
Expand Down Expand Up @@ -2057,7 +2073,8 @@ added: v0.11.15
-->

* `value` {number} Number to be written to `buf`.
* `offset` {integer} Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - 8`.
* `offset` {integer} Number of bytes to skip before starting to write.
Must satisfy: `0 <= offset <= buf.length - 8`.
* `noAssert` {boolean} Skip `value` and `offset` validation? **Default:** `false`
* Returns: {integer} `offset` plus the number of bytes written.

Expand Down Expand Up @@ -2092,7 +2109,8 @@ added: v0.11.15
-->

* `value` {number} Number to be written to `buf`.
* `offset` {integer} Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - 4`.
* `offset` {integer} Number of bytes to skip before starting to write.
Must satisfy: `0 <= offset <= buf.length - 4`.
* `noAssert` {boolean} Skip `value` and `offset` validation? **Default:** `false`
* Returns: {integer} `offset` plus the number of bytes written.

Expand Down Expand Up @@ -2126,7 +2144,8 @@ added: v0.5.0
-->

* `value` {integer} Number to be written to `buf`.
* `offset` {integer} Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - 1`.
* `offset` {integer} Number of bytes to skip before starting to write.
Must satisfy: `0 <= offset <= buf.length - 1`.
* `noAssert` {boolean} Skip `value` and `offset` validation? **Default:** `false`
* Returns: {integer} `offset` plus the number of bytes written.

Expand Down Expand Up @@ -2158,7 +2177,8 @@ added: v0.5.5
-->

* `value` {integer} Number to be written to `buf`.
* `offset` {integer} Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - 2`.
* `offset` {integer} Number of bytes to skip before starting to write.
Must satisfy: `0 <= offset <= buf.length - 2`.
* `noAssert` {boolean} Skip `value` and `offset` validation? **Default:** `false`
* Returns: {integer} `offset` plus the number of bytes written.

Expand Down Expand Up @@ -2191,7 +2211,8 @@ added: v0.5.5
-->

* `value` {integer} Number to be written to `buf`.
* `offset` {integer} Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - 4`.
* `offset` {integer} Number of bytes to skip before starting to write.
Must satisfy: `0 <= offset <= buf.length - 4`.
* `noAssert` {boolean} Skip `value` and `offset` validation? **Default:** `false`
* Returns: {integer} `offset` plus the number of bytes written.

Expand Down Expand Up @@ -2224,7 +2245,8 @@ added: v0.11.15
-->

* `value` {integer} Number to be written to `buf`.
* `offset` {integer} Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - byteLength`.
* `offset` {integer} Number of bytes to skip before starting to write.
Must satisfy: `0 <= offset <= buf.length - byteLength`.
* `byteLength` {integer} Number of bytes to write. Must satisfy: `0 < byteLength <= 6`.
* `noAssert` {boolean} Skip `value`, `offset`, and `byteLength` validation?
**Default:** `false`
Expand Down Expand Up @@ -2259,7 +2281,8 @@ added: v0.5.0
-->

* `value` {integer} Number to be written to `buf`.
* `offset` {integer} Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - 1`.
* `offset` {integer} Number of bytes to skip before starting to write.
Must satisfy: `0 <= offset <= buf.length - 1`.
* `noAssert` {boolean} Skip `value` and `offset` validation? **Default:** `false`
* Returns: {integer} `offset` plus the number of bytes written.

Expand Down Expand Up @@ -2291,7 +2314,8 @@ added: v0.5.5
-->

* `value` {integer} Number to be written to `buf`.
* `offset` {integer} Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - 2`.
* `offset` {integer} Number of bytes to skip before starting to write.
Must satisfy: `0 <= offset <= buf.length - 2`.
* `noAssert` {boolean} Skip `value` and `offset` validation? **Default:** `false`
* Returns: {integer} `offset` plus the number of bytes written.

Expand Down Expand Up @@ -2328,7 +2352,8 @@ added: v0.5.5
-->

* `value` {integer} Number to be written to `buf`.
* `offset` {integer} Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - 4`.
* `offset` {integer} Number of bytes to skip before starting to write.
Must satisfy: `0 <= offset <= buf.length - 4`.
* `noAssert` {boolean} Skip `value` and `offset` validation? **Default:** `false`
* Returns: {integer} `offset` plus the number of bytes written.

Expand Down Expand Up @@ -2363,8 +2388,10 @@ added: v0.5.5
-->

* `value` {integer} Number to be written to `buf`.
* `offset` {integer} Number of bytes to skip before starting to write. Must satisfy: `0 <= offset <= buf.length - byteLength`.
* `byteLength` {integer} Number of bytes to write. Must satisfy: `0 < byteLength <= 6`.
* `offset` {integer} Number of bytes to skip before starting to write.
Must satisfy: `0 <= offset <= buf.length - byteLength`.
* `byteLength` {integer} Number of bytes to write. Must satisfy:
`0 < byteLength <= 6`.
* `noAssert` {boolean} Skip `value`, `offset`, and `byteLength` validation?
**Default:** `false`
* Returns: {integer} `offset` plus the number of bytes written.
Expand Down
6 changes: 4 additions & 2 deletions doc/api/child_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,7 +217,8 @@ added: v0.1.91
* `encoding` {string} **Default:** `'utf8'`
* `timeout` {number} **Default:** `0`
* [`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'`
* `uid` {number} Sets the user identity of the process (see setuid(2)).
* `gid` {number} Sets the group identity of the process (see setgid(2)).
Expand Down Expand Up @@ -601,7 +602,8 @@ added: v0.11.12
process will be killed. **Default:** `'SIGTERM'`
* [`maxBuffer`][] {number} Largest amount of data (in bytes) allowed on
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.

The `child_process.execFileSync()` method is generally identical to
Expand Down