Skip to content

Commit

Permalink
doc: document buffer's "Uint" aliases clearly
Browse files Browse the repository at this point in the history
Fixes: #36751

PR-URL: #36796
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Harshitha K P <harshitha014@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
  • Loading branch information
targos authored and danielleadams committed Jan 12, 2021
1 parent 9d25d25 commit 7c7180a
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions doc/api/buffer.md
Original file line number Diff line number Diff line change
Expand Up @@ -1431,6 +1431,8 @@ changes:
Reads an unsigned, big-endian 64-bit integer from `buf` at the specified
`offset`.

This function is also available under the `readBigUint64BE` alias.

```js
const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);

Expand Down Expand Up @@ -1458,6 +1460,8 @@ changes:
Reads an unsigned, little-endian 64-bit integer from `buf` at the specified
`offset`.

This function is also available under the `readBigUint64LE` alias.

```js
const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);

Expand Down Expand Up @@ -1775,6 +1779,8 @@ changes:

Reads an unsigned 8-bit integer from `buf` at the specified `offset`.

This function is also available under the `readUint8` alias.

```js
const buf = Buffer.from([1, -2]);

Expand Down Expand Up @@ -1808,6 +1814,8 @@ changes:
Reads an unsigned, big-endian 16-bit integer from `buf` at the specified
`offset`.

This function is also available under the `readUint16BE` alias.

```js
const buf = Buffer.from([0x12, 0x34, 0x56]);

Expand Down Expand Up @@ -1839,6 +1847,8 @@ changes:
Reads an unsigned, little-endian 16-bit integer from `buf` at the specified
`offset`.

This function is also available under the `readUint16LE` alias.

```js
const buf = Buffer.from([0x12, 0x34, 0x56]);

Expand Down Expand Up @@ -1872,6 +1882,8 @@ changes:
Reads an unsigned, big-endian 32-bit integer from `buf` at the specified
`offset`.

This function is also available under the `readUint32BE` alias.

```js
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);

Expand Down Expand Up @@ -1901,6 +1913,8 @@ changes:
Reads an unsigned, little-endian 32-bit integer from `buf` at the specified
`offset`.

This function is also available under the `readUint32LE` alias.

```js
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);

Expand Down Expand Up @@ -1935,6 +1949,8 @@ Reads `byteLength` number of bytes from `buf` at the specified `offset`
and interprets the result as an unsigned big-endian integer supporting
up to 48 bits of accuracy.

This function is also available under the `readUintBE` alias.

```js
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);

Expand Down Expand Up @@ -1969,6 +1985,8 @@ Reads `byteLength` number of bytes from `buf` at the specified `offset`
and interprets the result as an unsigned, little-endian integer supporting
up to 48 bits of accuracy.

This function is also available under the `readUintLE` alias.

```js
const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);

Expand Down Expand Up @@ -2384,6 +2402,8 @@ changes:

Writes `value` to `buf` at the specified `offset` as big-endian.

This function is also available under the `writeBigUint64BE` alias.

```js
const buf = Buffer.allocUnsafe(8);

Expand Down Expand Up @@ -2422,6 +2442,8 @@ console.log(buf);
// Prints: <Buffer de fa ce ca fe fa ca de>
```

This function is also available under the `writeBigUint64LE` alias.

### `buf.writeDoubleBE(value[, offset])`
<!-- YAML
added: v0.11.15
Expand Down Expand Up @@ -2769,6 +2791,8 @@ Writes `value` to `buf` at the specified `offset`. `value` must be a
valid unsigned 8-bit integer. Behavior is undefined when `value` is anything
other than an unsigned 8-bit integer.

This function is also available under the `writeUint8` alias.

```js
const buf = Buffer.allocUnsafe(4);

Expand Down Expand Up @@ -2805,6 +2829,8 @@ Writes `value` to `buf` at the specified `offset` as big-endian. The `value`
must be a valid unsigned 16-bit integer. Behavior is undefined when `value`
is anything other than an unsigned 16-bit integer.

This function is also available under the `writeUint16BE` alias.

```js
const buf = Buffer.allocUnsafe(4);

Expand Down Expand Up @@ -2839,6 +2865,8 @@ Writes `value` to `buf` at the specified `offset` as little-endian. The `value`
must be a valid unsigned 16-bit integer. Behavior is undefined when `value` is
anything other than an unsigned 16-bit integer.

This function is also available under the `writeUint16LE` alias.

```js
const buf = Buffer.allocUnsafe(4);

Expand Down Expand Up @@ -2873,6 +2901,8 @@ Writes `value` to `buf` at the specified `offset` as big-endian. The `value`
must be a valid unsigned 32-bit integer. Behavior is undefined when `value`
is anything other than an unsigned 32-bit integer.

This function is also available under the `writeUint32BE` alias.

```js
const buf = Buffer.allocUnsafe(4);

Expand Down Expand Up @@ -2906,6 +2936,8 @@ Writes `value` to `buf` at the specified `offset` as little-endian. The `value`
must be a valid unsigned 32-bit integer. Behavior is undefined when `value` is
anything other than an unsigned 32-bit integer.

This function is also available under the `writeUint32LE` alias.

```js
const buf = Buffer.allocUnsafe(4);

Expand Down Expand Up @@ -2941,6 +2973,8 @@ Writes `byteLength` bytes of `value` to `buf` at the specified `offset`
as big-endian. Supports up to 48 bits of accuracy. Behavior is undefined
when `value` is anything other than an unsigned integer.

This function is also available under the `writeUintBE` alias.

```js
const buf = Buffer.allocUnsafe(6);

Expand Down Expand Up @@ -2976,6 +3010,8 @@ Writes `byteLength` bytes of `value` to `buf` at the specified `offset`
as little-endian. Supports up to 48 bits of accuracy. Behavior is undefined
when `value` is anything other than an unsigned integer.

This function is also available under the `writeUintLE` alias.

```js
const buf = Buffer.allocUnsafe(6);

Expand Down

0 comments on commit 7c7180a

Please sign in to comment.