diff --git a/doc/api/buffer.md b/doc/api/buffer.md index cbbf3e723e4a90..765aa2dd088e84 100644 --- a/doc/api/buffer.md +++ b/doc/api/buffer.md @@ -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]); @@ -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]); @@ -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]); @@ -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]); @@ -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]); @@ -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]); @@ -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]); @@ -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]); @@ -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]); @@ -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); @@ -2422,6 +2442,8 @@ console.log(buf); // Prints: ``` +This function is also available under the `writeBigUint64LE` alias. + ### `buf.writeDoubleBE(value[, offset])`