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

doc: clarify length param in buffer.write

Browse Source 
`buffer.write` documentation has an incaccuracy w.r.t the `length`
parameter: It says default number of bytes written is
`buf.length - offset`. Change it to:
If the buffer has sufficient space from the offset, the string is
written upto `length`.
If the buffer is short in space, only `buf.length - offset` bytes are
written.

Refs: https://github.com/nodejs/node/pull/32104#discussion_r388524733

PR-URL: https://github.com/nodejs/node/pull/32119
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
This commit is contained in:
Harshitha KP 2020-03-06 01:10:40 -05:00 committed by Anna Henningsen
parent c452632d34
commit d03d9a05f0
No known key found for this signature in database
GPG Key ID: A94130F0BFC8EBE9
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/api/buffer.md
View File

@ -1994,8 +1994,8 @@ added: v0.1.90
* `string` {string} String to write to `buf`. * `string` {string} String to write to `buf`.
* `offset` {integer} Number of bytes to skip before starting to write `string`. * `offset` {integer} Number of bytes to skip before starting to write `string`.
**Default:** `0`. **Default:** `0`.
* `length` {integer} Maximum number of bytes to write. **Default:** * `length` {integer} Maximum number of bytes to write (written bytes will not
`buf.length - offset`. exceed `buf.length - offset`). **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.
@ -2011,6 +2011,13 @@ const len = buf.write('\u00bd + \u00bc = \u00be', 0);
console.log(`${len} bytes: ${buf.toString('utf8', 0, len)}`); console.log(`${len} bytes: ${buf.toString('utf8', 0, len)}`);
// Prints: 12 bytes: ½ + ¼ = ¾ // Prints: 12 bytes: ½ + ¼ = ¾
const buffer = Buffer.alloc(10);
const length = buffer.write('abcd', 8);
console.log(`${length} bytes: ${buffer.toString('utf8', 8, 10)}`);
// Prints: 2 bytes : ab
``` ```
### `buf.writeBigInt64BE(value[, offset])` ### `buf.writeBigInt64BE(value[, offset])`