GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing github.com — doc: document buffer's "Uint" aliases clearly · nodejs/node@cf0fa7f

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

doc/api
- buffer.md

Expand file treeCollapse file tree

Open diff view settings

Collapse file

`‎doc/api/buffer.md‎`

Copy file name to clipboardExpand all lines: doc/api/buffer.md

+36Lines changed: 36 additions & 0 deletions

Display the source diff
Display the rich diff

Original file line number	Diff line number	Diff line change
`@@ -1416,6 +1416,8 @@ changes:`
`1416`	`1416`	Reads an unsigned, big-endian 64-bit integer from `buf` at the specified
`1417`	`1417`	`offset`.
`1418`	`1418`
	`1419`	+This function is also available under the `readBigUint64BE` alias.
	`1420`	`+`
`1419`	`1421`	```js
`1420`	`1422`	`const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);`
`1421`	`1423`
`@@ -1443,6 +1445,8 @@ changes:`
`1443`	`1445`	Reads an unsigned, little-endian 64-bit integer from `buf` at the specified
`1444`	`1446`	`offset`.
`1445`	`1447`
	`1448`	+This function is also available under the `readBigUint64LE` alias.
	`1449`	`+`
`1446`	`1450`	```js
`1447`	`1451`	`const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);`
`1448`	`1452`
`@@ -1758,6 +1762,8 @@ changes:`
`1758`	`1762`
`1759`	`1763`	Reads an unsigned 8-bit integer from `buf` at the specified `offset`.
`1760`	`1764`
	`1765`	+This function is also available under the `readUint8` alias.
	`1766`	`+`
`1761`	`1767`	```js
`1762`	`1768`	`const buf = Buffer.from([1, -2]);`
`1763`	`1769`
`@@ -1789,6 +1795,8 @@ changes:`
`1789`	`1795`	Reads an unsigned, big-endian 16-bit integer from `buf` at the specified
`1790`	`1796`	`offset`.
`1791`	`1797`
	`1798`	+This function is also available under the `readUint16BE` alias.
	`1799`	`+`
`1792`	`1800`	```js
`1793`	`1801`	`const buf = Buffer.from([0x12, 0x34, 0x56]);`
`1794`	`1802`
`@@ -1818,6 +1826,8 @@ changes:`
`1818`	`1826`	Reads an unsigned, little-endian 16-bit integer from `buf` at the specified
`1819`	`1827`	`offset`.
`1820`	`1828`
	`1829`	+This function is also available under the `readUint16LE` alias.
	`1830`	`+`
`1821`	`1831`	```js
`1822`	`1832`	`const buf = Buffer.from([0x12, 0x34, 0x56]);`
`1823`	`1833`
`@@ -1849,6 +1859,8 @@ changes:`
`1849`	`1859`	Reads an unsigned, big-endian 32-bit integer from `buf` at the specified
`1850`	`1860`	`offset`.
`1851`	`1861`
	`1862`	+This function is also available under the `readUint32BE` alias.
	`1863`	`+`
`1852`	`1864`	```js
`1853`	`1865`	`const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);`
`1854`	`1866`
`@@ -1876,6 +1888,8 @@ changes:`
`1876`	`1888`	Reads an unsigned, little-endian 32-bit integer from `buf` at the specified
`1877`	`1889`	`offset`.
`1878`	`1890`
	`1891`	+This function is also available under the `readUint32LE` alias.
	`1892`	`+`
`1879`	`1893`	```js
`1880`	`1894`	`const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);`
`1881`	`1895`
@@ -1908,6 +1922,8 @@ Reads `byteLength` number of bytes from `buf` at the specified `offset`
`1908`	`1922`	`and interprets the result as an unsigned big-endian integer supporting`
`1909`	`1923`	`up to 48 bits of accuracy.`
`1910`	`1924`
	`1925`	+This function is also available under the `readUintBE` alias.
	`1926`	`+`
`1911`	`1927`	```js
`1912`	`1928`	`const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);`
`1913`	`1929`
@@ -1940,6 +1956,8 @@ Reads `byteLength` number of bytes from `buf` at the specified `offset`
`1940`	`1956`	`and interprets the result as an unsigned, little-endian integer supporting`
`1941`	`1957`	`up to 48 bits of accuracy.`
`1942`	`1958`
	`1959`	+This function is also available under the `readUintLE` alias.
	`1960`	`+`
`1943`	`1961`	```js
`1944`	`1962`	`const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);`
`1945`	`1963`
`@@ -2353,6 +2371,8 @@ changes:`
`2353`	`2371`
`2354`	`2372`	Writes `value` to `buf` at the specified `offset` as big-endian.
`2355`	`2373`
	`2374`	+This function is also available under the `writeBigUint64BE` alias.
	`2375`	`+`
`2356`	`2376`	```js
`2357`	`2377`	`const buf = Buffer.allocUnsafe(8);`
`2358`	`2378`
`@@ -2389,6 +2409,8 @@ console.log(buf);`
`2389`	`2409`	`// Prints: <Buffer de fa ce ca fe fa ca de>`
`2390`	`2410`	```
`2391`	`2411`
	`2412`	+This function is also available under the `writeBigUint64LE` alias.
	`2413`	`+`
`2392`	`2414`	### `buf.writeDoubleBE(value[, offset])`
`2393`	`2415`	`<!-- YAML`
`2394`	`2416`	`added: v0.11.15`
@@ -2734,6 +2756,8 @@ Writes `value` to `buf` at the specified `offset`. `value` must be a
`2734`	`2756`	valid unsigned 8-bit integer. Behavior is undefined when `value` is anything
`2735`	`2757`	`other than an unsigned 8-bit integer.`
`2736`	`2758`
	`2759`	+This function is also available under the `writeUint8` alias.
	`2760`	`+`
`2737`	`2761`	```js
`2738`	`2762`	`const buf = Buffer.allocUnsafe(4);`
`2739`	`2763`
@@ -2768,6 +2792,8 @@ Writes `value` to `buf` at the specified `offset` as big-endian. The `value`
`2768`	`2792`	must be a valid unsigned 16-bit integer. Behavior is undefined when `value`
`2769`	`2793`	`is anything other than an unsigned 16-bit integer.`
`2770`	`2794`
	`2795`	+This function is also available under the `writeUint16BE` alias.
	`2796`	`+`
`2771`	`2797`	```js
`2772`	`2798`	`const buf = Buffer.allocUnsafe(4);`
`2773`	`2799`
@@ -2802,6 +2828,8 @@ Writes `value` to `buf` at the specified `offset` as little-endian. The `value`
`2802`	`2828`	must be a valid unsigned 16-bit integer. Behavior is undefined when `value` is
`2803`	`2829`	`anything other than an unsigned 16-bit integer.`
`2804`	`2830`
	`2831`	+This function is also available under the `writeUint16LE` alias.
	`2832`	`+`
`2805`	`2833`	```js
`2806`	`2834`	`const buf = Buffer.allocUnsafe(4);`
`2807`	`2835`
@@ -2834,6 +2862,8 @@ Writes `value` to `buf` at the specified `offset` as big-endian. The `value`
`2834`	`2862`	must be a valid unsigned 32-bit integer. Behavior is undefined when `value`
`2835`	`2863`	`is anything other than an unsigned 32-bit integer.`
`2836`	`2864`
	`2865`	+This function is also available under the `writeUint32BE` alias.
	`2866`	`+`
`2837`	`2867`	```js
`2838`	`2868`	`const buf = Buffer.allocUnsafe(4);`
`2839`	`2869`
@@ -2865,6 +2895,8 @@ Writes `value` to `buf` at the specified `offset` as little-endian. The `value`
`2865`	`2895`	must be a valid unsigned 32-bit integer. Behavior is undefined when `value` is
`2866`	`2896`	`anything other than an unsigned 32-bit integer.`
`2867`	`2897`
	`2898`	+This function is also available under the `writeUint32LE` alias.
	`2899`	`+`
`2868`	`2900`	```js
`2869`	`2901`	`const buf = Buffer.allocUnsafe(4);`
`2870`	`2902`
@@ -2898,6 +2930,8 @@ Writes `byteLength` bytes of `value` to `buf` at the specified `offset`
`2898`	`2930`	`as big-endian. Supports up to 48 bits of accuracy. Behavior is undefined`
`2899`	`2931`	when `value` is anything other than an unsigned integer.
`2900`	`2932`
	`2933`	+This function is also available under the `writeUintBE` alias.
	`2934`	`+`
`2901`	`2935`	```js
`2902`	`2936`	`const buf = Buffer.allocUnsafe(6);`
`2903`	`2937`
@@ -2931,6 +2965,8 @@ Writes `byteLength` bytes of `value` to `buf` at the specified `offset`
`2931`	`2965`	`as little-endian. Supports up to 48 bits of accuracy. Behavior is undefined`
`2932`	`2966`	when `value` is anything other than an unsigned integer.
`2933`	`2967`
	`2968`	+This function is also available under the `writeUintLE` alias.
	`2969`	`+`
`2934`	`2970`	```js
`2935`	`2971`	`const buf = Buffer.allocUnsafe(6);`
`2936`	`2972`

0 commit comments

Comments

0 (0)

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.