1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: clarify optional arguments of Buffer methods

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/5008
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
This commit is contained in:
Michaël Zasso 2016-01-31 16:58:39 +01:00
parent 977159f149
commit 4501a28ad9
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/api/buffer.markdown
View File

@ -388,7 +388,7 @@ console.log(buf2.compare(buf3));
// produces sort order [buf1, buf3, buf2] // produces sort order [buf1, buf3, buf2]
``` ```
### buf.copy(targetBuffer[, targetStart][, sourceStart][, sourceEnd]) ### buf.copy(targetBuffer[, targetStart[, sourceStart[, sourceEnd]]])
* `targetBuffer` {Buffer} Buffer to copy into * `targetBuffer` {Buffer} Buffer to copy into
* `targetStart` {Number} Default: 0 * `targetStart` {Number} Default: 0
@ -471,7 +471,7 @@ console.log(buf1.equals(buf3));
// Prints: false // Prints: false
``` ```
### buf.fill(value[, offset][, end]) ### buf.fill(value[, offset[, end]])
* `value` {String or Number} * `value` {String or Number}
* `offset` {Number} Default: 0 * `offset` {Number} Default: 0
@ -915,7 +915,7 @@ buf.slice(-5, -2).toString();
// Returns 'uff', equivalent to buf.slice(1, 4) // Returns 'uff', equivalent to buf.slice(1, 4)
``` ```
### buf.toString([encoding][, start][, end]) ### buf.toString([encoding[, start[, end]]])
* `encoding` {String} Default: `'utf8'` * `encoding` {String} Default: `'utf8'`
* `start` {Number} Default: 0 * `start` {Number} Default: 0
@ -998,7 +998,7 @@ for (var value of buf) {
// 114 // 114
``` ```
### buf.write(string[, offset][, length][, encoding]) ### buf.write(string[, offset[, length]][, encoding])
* `string` {String} Bytes to be written to buffer * `string` {String} Bytes to be written to buffer
* `offset` {Number} Default: 0 * `offset` {Number} Default: 0