Skip to content

doc: document undocumented methods on buffer prototype #48041

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
Xstoudi wants to merge 7 commits into from
Closed

doc: document undocumented methods on buffer prototype #48041

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3e2bb60
doc: document undocumented method on buffer prototype
Xstoudi May 16, 2023
a2526d0
doc: lint markdown
Xstoudi May 17, 2023
85c958f
doc: remove trailing spaces
Xstoudi May 17, 2023
69433b7
doc: forgot two trailing spaces
Xstoudi May 17, 2023
2eca8b0
fix: remove trailing spaces
Xstoudi May 21, 2023
3145d10
doc: add added date meta
Xstoudi May 21, 2023
737bc2e
doc: add missing console.log(bytesWritten)
trivikr Jul 27, 2023
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
Next Next commit
doc: lint markdown
  • Loading branch information
@Xstoudi
Xstoudi committed May 17, 2023
commit a2526d0c5be48cbeb07d15248abc12cb884780be
78 changes: 51 additions & 27 deletions doc/api/buffer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3515,16 +3515,18 @@ console.log(buf.toString());
// Also prints: cuffer (!)
```


### `buf.asciiSlice([start[, end]])`

* `start` {integer} The byte offset to start slicing at. **Default**: 0.
* `end` {integer} The byte offset to stop slicing at (not inclusive). **Default**: `buf.length`.
* `end` {integer} The byte offset to stop slicing at (not inclusive).
**Default**: `buf.length`.
* Returns: {string}

Decodes buf to a string according ASCII character encoding. `start` and `end` may be passed to decode only a subset of `buf`.
Decodes buf to a string according ASCII character encoding. `start` and
`end` may be passed to decode only a subset of `buf`.

In most cases, `buf.toString()` is preferable, especially if encoding is variable.
In most cases, `buf.toString()` is preferable, especially if encoding is
variable.

```mjs
import { Buffer } from 'node:buffer';
Expand All @@ -3547,10 +3549,12 @@ console.log(buf.asciiSlice(0, 3));
### `buf.base64Slice([start[, end]])`

* `start` {integer} The byte offset to start slicing at. **Default**: 0.
* `end` {integer} The byte offset to stop decoding at (not inclusive). **Default**: `buf.length`.
* `end` {integer} The byte offset to stop decoding at (not inclusive).
**Default**: `buf.length`.
* Returns: {string}

Decodes buf to a string according to base64 character encoding. `start` and `end` may be passed to decode only a subset of `buf`.
Decodes buf to a string according to base64 character encoding. `start` and
`end` may be passed to decode only a subset of `buf`.

```mjs
import { Buffer } from 'node:buffer';
Expand All @@ -3573,10 +3577,12 @@ console.log(buf.base64Slice(0, 3));
### `buf.base64urlSlice([start[, end]])`

* `start` {integer} The byte offset to start slicing at. **Default**: 0.
* `end` {integer} The byte offset to stop decoding at (not inclusive). **Default**: `buf.length`.
* `end` {integer} The byte offset to stop decoding at (not inclusive).
**Default**: `buf.length`.
* Returns: {string}

Decodes buf to a string according to base64url character encoding. `start` and `end` may be passed to decode only a subset of `buf`.
Decodes buf to a string according to base64url character encoding. `start`
and `end` may be passed to decode only a subset of `buf`.

```mjs
import { Buffer } from 'node:buffer';
Expand All @@ -3599,10 +3605,12 @@ console.log(buf.base64urlSlice(0, 3));
### `buf.hexSlice([start[, end]])`

* `start` {integer} The byte offset to start slicing at. **Default**: 0.
* `end` {integer} The byte offset to stop decoding at (not inclusive). **Default**: `buf.length`.
* `end` {integer} The byte offset to stop decoding at (not inclusive).
**Default**: `buf.length`.
* Returns: {string}

Decodes buf to a string according to hex character encoding. `start` and `end` may be passed to decode only a subset of `buf`.
Decodes buf to a string according to hex character encoding. `start` and
`end` may be passed to decode only a subset of `buf`.

```mjs
import { Buffer } from 'node:buffer';
Expand All @@ -3625,10 +3633,12 @@ console.log(buf.hexSlice(0, 3));
### `buf.latin1Slice([start[, end]])`

* `start` {integer} The byte offset to start slicing at. **Default**: 0.
* `end` {integer} The byte offset to stop slicing at (not inclusive). **Default**: `buf.length`.
* `end` {integer} The byte offset to stop slicing at (not inclusive).
**Default**: `buf.length`.
* Returns: {string}

Decodes buf to a string according to latin1 character encoding. `start` and `end` may be passed to decode only a subset of `buf`.
Decodes buf to a string according to latin1 character encoding. `start` and
`end` may be passed to decode only a subset of `buf`.

```mjs
import { Buffer } from 'node:buffer';
Expand All @@ -3651,10 +3661,12 @@ console.log(buf.latin1Slice(0, 3));
### `buf.ucs2Slice([start[, end]])`

* `start` {integer} The byte offset to start slicing at. **Default**: 0.
* `end` {integer} The byte offset to stop slicing at (not inclusive). **Default**: `buf.length`.
* `end` {integer} The byte offset to stop slicing at (not inclusive).
**Default**: `buf.length`.
* Returns: {string}

Decodes buf to a string according to UCS-2 character encoding. `start` and `end` may be passed to decode only a subset of `buf`.
Decodes buf to a string according to UCS-2 character encoding. `start` and
`end` may be passed to decode only a subset of `buf`.

```mjs
import { Buffer } from 'node:buffer';
Expand All @@ -3677,10 +3689,12 @@ console.log(buf.ucs2Slice(0, 3));
### `buf.utf8Slice([start[, end]])`

* `start` {integer} The byte offset to start slicing at. **Default**: 0.
* `end` {integer} The byte offset to stop slicing at (not inclusive). **Default**: `buf.length`.
* `end` {integer} The byte offset to stop slicing at (not inclusive).
**Default**: `buf.length`.
* Returns: {string}

Decodes buf to a string according to UTF-8 character encoding. `start` and `end` may be passed to decode only a subset of `buf`.
Decodes buf to a string according to UTF-8 character encoding. `start` and
`end` may be passed to decode only a subset of `buf`.

```mjs
import { Buffer } from 'node:buffer';
Expand All @@ -3703,12 +3717,14 @@ console.log(buf.utf8Slice(0, 3));
### `buf.asciiWrite(string[, offset[, length]])`

* `string` {string} String to write to `buf`.
Copy link
Copy Markdown
Contributor

@aduh95 aduh95 Aug 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does the string needs to be ASCII? Or what happens if it contains non-ASCII chars?

* `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`.
* `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`.

Writes `string` to `buf` at `offset` according to the ASCII character encoding
and returns the number of bytes written. If `buf` did not contain enough space
to fit the entire string, only part of `string` will be written. However,
to fit the entire string, only part of `string` will be written. However,
partially encoded characters will not be written.

In most cases, `buf.write` is preferable, especially if `encoding` is variable.
Expand All @@ -3733,8 +3749,10 @@ console.log(bytesWritten);
### `buf.base64Write(string[, offset[, length]])`

* `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`.
* `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`.
* Returns: {integer} The number of bytes written.

Writes `string` to `buf` at `offset` according to the base64 character encoding
Expand Down Expand Up @@ -3797,8 +3815,10 @@ console.log(bytesWritten);
### `buf.hexWrite(string[, offset[, length]])`

* `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`.
* `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`.
* Returns: {integer} The number of bytes written.

Writes `string` to `buf` at `offset` according to the hex character encoding
Expand Down Expand Up @@ -3829,8 +3849,10 @@ console.log(bytesWritten);
### `buf.latin1Write(string[, offset[, length]])`

* `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`.
* `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`.
* Returns: {integer} The number of bytes written.

Writes `string` to `buf` at `offset` according to the latin1 character encoding
Expand Down Expand Up @@ -3861,8 +3883,10 @@ console.log(bytesWritten);
### `buf.utf8Write(string[, offset[, length]])`

* `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`.
* `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`.
* Returns: {integer} The number of bytes written.

Writes `string` to `buf` at `offset` according to the utf8 character encoding
Expand Down