Skip to content

doc: clarify length param in buffer.write #32119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
HarshithaKP wants to merge 6 commits into from
Closed

doc: clarify length param in buffer.write #32119

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7841713
doc: clarify `length` param in `buffer.write`
HarshithaKP Mar 6, 2020
661c800
fixup: fix some rebase issues
HarshithaKP Mar 13, 2020
28d0f9b
fixup: address review comment
HarshithaKP Mar 14, 2020
34e55ec
fixup: address review comment
HarshithaKP Mar 30, 2020
b0e0bbe
fixup : bring back deleted number
HarshithaKP Mar 30, 2020
6956024
fixup: bring back deleted number
HarshithaKP Mar 30, 2020
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
11 changes: 9 additions & 2 deletions doc/api/buffer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1994,8 +1994,8 @@ added: v0.1.90
* `string` {string} String to write to `buf`.
* `offset` {integer} Number of bytes to skip before starting to write `string`.
**Default:** `0`.
* `length` {integer} Maximum number of bytes to write. **Default:**
`buf.length - offset`.
* `length` {integer} Maximum number of bytes to write (written bytes will not
exceed `buf.length - offset`). **Default:** `buf.length - offset`.
* `encoding` {string} The character encoding of `string`. **Default:** `'utf8'`.
* Returns: {integer} Number of bytes written.

Expand All @@ -2011,6 +2011,13 @@ const len = buf.write('\u00bd + \u00bc = \u00be', 0);

console.log(`${len} bytes: ${buf.toString('utf8', 0, len)}`);
// 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])`
Expand Down