Home Original page

doc: add/fix version metadata for Buffer methods · nodejs/node@b3127df

@@ -604,6 +604,9 @@ a developer has observed undue memory retention in their applications.

604604

A `TypeError` will be thrown if `size` is not a number.

605605606606

### Class Method: Buffer.byteLength(string[, encoding])

607+

<!-- YAML

608+

added: v0.1.90

609+

-->

607610608611

* `string` {String | Buffer | TypedArray | DataView | ArrayBuffer} A value to

609612

calculate the length of

@@ -698,7 +701,7 @@ console.log(bufA.length);

698701699702

### Class Method: Buffer.from(array)

700703

<!-- YAML

701-

added: v3.0.0

704+

added: v5.10.0

702705

-->

703706704707

* `array` {Array}

@@ -767,7 +770,7 @@ A `TypeError` will be thrown if `arrayBuffer` is not an [`ArrayBuffer`].

767770768771

### Class Method: Buffer.from(buffer)

769772

<!-- YAML

770-

added: v3.0.0

773+

added: v5.10.0

771774

-->

772775773776

* `buffer` {Buffer} An existing `Buffer` to copy data from

@@ -823,6 +826,9 @@ console.log(buf2.toString());

823826

A `TypeError` will be thrown if `str` is not a string.

824827825828

### Class Method: Buffer.isBuffer(obj)

829+

<!-- YAML

830+

added: v0.1.101

831+

-->

826832827833

* `obj` {Object}

828834

* Return: {Boolean}

@@ -951,6 +957,9 @@ A `RangeError` will be thrown if: `targetStart < 0`, `sourceStart < 0`,

951957

`targetEnd > target.byteLength` or `sourceEnd > source.byteLength`.

952958953959

### buf.copy(target[, targetStart[, sourceStart[, sourceEnd]]])

960+

<!-- YAML

961+

added: v0.1.90

962+

-->

954963955964

* `target` {Buffer} A `Buffer` to copy into.

956965

* `targetStart` {Integer} The offset within `target` at which to begin

@@ -1028,7 +1037,7 @@ for (var pair of buf.entries()) {

1028103710291038

### buf.equals(otherBuffer)

10301039

<!-- YAML

1031-

added: v1.0.0

1040+

added: v0.11.13

10321041

-->

1033104210341043

* `otherBuffer` {Buffer} A `Buffer` to compare to

@@ -1264,6 +1273,9 @@ console.log(utf16Buffer.lastIndexOf('\u03a3', -5, 'ucs2'));

12641273

```

1265127412661275

### buf.length

1276+

<!-- YAML

1277+

added: v0.1.90

1278+

-->

1267127912681280

* {Integer}

12691281

@@ -1307,6 +1319,9 @@ console.log(buf.length);

1307131913081320

### buf.readDoubleBE(offset[, noAssert])

13091321

### buf.readDoubleLE(offset[, noAssert])

1322+

<!-- YAML

1323+

added: v0.11.15

1324+

-->

1310132513111326

* `offset` {Integer} Where to start reading. Must satisfy: `0 <= offset <= buf.length - 8`

13121327

* `noAssert` {Boolean} Skip `offset` validation? **Default:** `false`

@@ -1340,6 +1355,9 @@ console.log(buf.readDoubleLE(1, true));

1340135513411356

### buf.readFloatBE(offset[, noAssert])

13421357

### buf.readFloatLE(offset[, noAssert])

1358+

<!-- YAML

1359+

added: v0.11.15

1360+

-->

1343136113441362

* `offset` {Integer} Where to start reading. Must satisfy: `0 <= offset <= buf.length - 4`

13451363

* `noAssert` {Boolean} Skip `offset` validation? **Default:** `false`

@@ -1372,6 +1390,9 @@ console.log(buf.readFloatLE(1, true));

13721390

```

1373139113741392

### buf.readInt8(offset[, noAssert])

1393+

<!-- YAML

1394+

added: v0.5.0

1395+

-->

1375139613761397

* `offset` {Integer} Where to start reading. Must satisfy: `0 <= offset <= buf.length - 1`

13771398

* `noAssert` {Boolean} Skip `offset` validation? **Default:** `false`

@@ -1401,6 +1422,9 @@ console.log(buf.readInt8(2));

1401142214021423

### buf.readInt16BE(offset[, noAssert])

14031424

### buf.readInt16LE(offset[, noAssert])

1425+

<!-- YAML

1426+

added: v0.5.5

1427+

-->

1404142814051429

* `offset` {Integer} Where to start reading. Must satisfy: `0 <= offset <= buf.length - 2`

14061430

* `noAssert` {Boolean} Skip `offset` validation? **Default:** `false`

@@ -1432,6 +1456,9 @@ console.log(buf.readInt16LE(1));

1432145614331457

### buf.readInt32BE(offset[, noAssert])

14341458

### buf.readInt32LE(offset[, noAssert])

1459+

<!-- YAML

1460+

added: v0.5.5

1461+

-->

1435146214361463

* `offset` {Integer} Where to start reading. Must satisfy: `0 <= offset <= buf.length - 4`

14371464

* `noAssert` {Boolean} Skip `offset` validation? **Default:** `false`

@@ -1464,7 +1491,7 @@ console.log(buf.readInt32LE(1));

14641491

### buf.readIntBE(offset, byteLength[, noAssert])

14651492

### buf.readIntLE(offset, byteLength[, noAssert])

14661493

<!-- YAML

1467-

added: v1.0.0

1494+

added: v0.11.15

14681495

-->

1469149614701497

* `offset` {Integer} Where to start reading. Must satisfy: `0 <= offset <= buf.length - byteLength`

@@ -1495,6 +1522,9 @@ console.log(buf.readIntBE(1, 6).toString(16));

14951522

```

1496152314971524

### buf.readUInt8(offset[, noAssert])

1525+

<!-- YAML

1526+

added: v0.5.0

1527+

-->

1498152814991529

* `offset` {Integer} Where to start reading. Must satisfy: `0 <= offset <= buf.length - 1`

15001530

* `noAssert` {Boolean} Skip `offset` validation? **Default:** `false`

@@ -1522,6 +1552,9 @@ console.log(buf.readUInt8(2));

1522155215231553

### buf.readUInt16BE(offset[, noAssert])

15241554

### buf.readUInt16LE(offset[, noAssert])

1555+

<!-- YAML

1556+

added: v0.5.5

1557+

-->

1525155815261559

* `offset` {Integer} Where to start reading. Must satisfy: `0 <= offset <= buf.length - 2`

15271560

* `noAssert` {Boolean} Skip `offset` validation? **Default:** `false`

@@ -1557,6 +1590,9 @@ console.log(buf.readUInt16LE(2).toString(16));

1557159015581591

### buf.readUInt32BE(offset[, noAssert])

15591592

### buf.readUInt32LE(offset[, noAssert])

1593+

<!-- YAML

1594+

added: v0.5.5

1595+

-->

1560159615611597

* `offset` {Integer} Where to start reading. Must satisfy: `0 <= offset <= buf.length - 4`

15621598

* `noAssert` {Boolean} Skip `offset` validation? **Default:** `false`

@@ -1587,7 +1623,7 @@ console.log(buf.readUInt32LE(1).toString(16));

15871623

### buf.readUIntBE(offset, byteLength[, noAssert])

15881624

### buf.readUIntLE(offset, byteLength[, noAssert])

15891625

<!-- YAML

1590-

added: v1.0.0

1626+

added: v0.11.15

15911627

-->

1592162815931629

* `offset` {Integer} Where to start reading. Must satisfy: `0 <= offset <= buf.length - byteLength`

@@ -1618,6 +1654,9 @@ console.log(buf.readUIntBE(1, 6).toString(16));

16181654

```

1619165516201656

### buf.slice([start[, end]])

1657+

<!-- YAML

1658+

added: v0.3.0

1659+

-->

1621166016221661

* `start` {Integer} Where the new `Buffer` will start. **Default:** `0`

16231662

* `end` {Integer} Where the new `Buffer` will end (not inclusive).

@@ -1767,6 +1806,9 @@ Note that JavaScript cannot encode 64-bit integers. This method is intended

17671806

for working with 64-bit floats.

1768180717691808

### buf.toString([encoding[, start[, end]]])

1809+

<!-- YAML

1810+

added: v0.1.90

1811+

-->

1770181217711813

* `encoding` {String} The character encoding to decode to. **Default:** `'utf8'`

17721814

* `start` {Integer} Where to start decoding. **Default:** `0`

@@ -1870,6 +1912,9 @@ for (var value of buf) {

18701912

```

1871191318721914

### buf.write(string[, offset[, length]][, encoding])

1915+

<!-- YAML

1916+

added: v0.1.90

1917+

-->

1873191818741919

* `string` {String} String to be written to `buf`

18751920

* `offset` {Integer} Where to start writing `string`. **Default:** `0`

@@ -1895,6 +1940,9 @@ console.log(`${len} bytes: ${buf.toString('utf8', 0, len)}`);

1895194018961941

### buf.writeDoubleBE(value, offset[, noAssert])

18971942

### buf.writeDoubleLE(value, offset[, noAssert])

1943+

<!-- YAML

1944+

added: v0.11.15

1945+

-->

1898194618991947

* `value` {Number} Number to be written to `buf`

19001948

* `offset` {Integer} Where to start writing. Must satisfy: `0 <= offset <= buf.length - 8`

@@ -1927,6 +1975,9 @@ console.log(buf);

1927197519281976

### buf.writeFloatBE(value, offset[, noAssert])

19291977

### buf.writeFloatLE(value, offset[, noAssert])

1978+

<!-- YAML

1979+

added: v0.11.15

1980+

-->

1930198119311982

* `value` {Number} Number to be written to `buf`

19321983

* `offset` {Integer} Where to start writing. Must satisfy: `0 <= offset <= buf.length - 4`

@@ -1958,6 +2009,9 @@ console.log(buf);

19582009

```

1959201019602011

### buf.writeInt8(value, offset[, noAssert])

2012+

<!-- YAML

2013+

added: v0.5.0

2014+

-->

1961201519622016

* `value` {Integer} Number to be written to `buf`

19632017

* `offset` {Integer} Where to start writing. Must satisfy: `0 <= offset <= buf.length - 1`

@@ -1987,6 +2041,9 @@ console.log(buf);

1987204119882042

### buf.writeInt16BE(value, offset[, noAssert])

19892043

### buf.writeInt16LE(value, offset[, noAssert])

2044+

<!-- YAML

2045+

added: v0.5.5

2046+

-->

1990204719912048

* `value` {Integer} Number to be written to `buf`

19922049

* `offset` {Integer} Where to start writing. Must satisfy: `0 <= offset <= buf.length - 2`

@@ -2017,6 +2074,9 @@ console.log(buf);

2017207420182075

### buf.writeInt32BE(value, offset[, noAssert])

20192076

### buf.writeInt32LE(value, offset[, noAssert])

2077+

<!-- YAML

2078+

added: v0.5.5

2079+

-->

2020208020212081

* `value` {Integer} Number to be written to `buf`

20222082

* `offset` {Integer} Where to start writing. Must satisfy: `0 <= offset <= buf.length - 4`

@@ -2048,7 +2108,7 @@ console.log(buf);

20482108

### buf.writeIntBE(value, offset, byteLength[, noAssert])

20492109

### buf.writeIntLE(value, offset, byteLength[, noAssert])

20502110

<!-- YAML

2051-

added: v1.0.0

2111+

added: v0.11.15

20522112

-->

2053211320542114

* `value` {Integer} Number to be written to `buf`

@@ -2082,6 +2142,9 @@ console.log(buf);

20822142

```

2083214320842144

### buf.writeUInt8(value, offset[, noAssert])

2145+

<!-- YAML

2146+

added: v0.5.0

2147+

-->

2085214820862149

* `value` {Integer} Number to be written to `buf`

20872150

* `offset` {Integer} Where to start writing. Must satisfy: `0 <= offset <= buf.length - 1`

@@ -2111,6 +2174,9 @@ console.log(buf);

2111217421122175

### buf.writeUInt16BE(value, offset[, noAssert])

21132176

### buf.writeUInt16LE(value, offset[, noAssert])

2177+

<!-- YAML

2178+

added: v0.5.5

2179+

-->

2114218021152181

* `value` {Integer} Number to be written to `buf`

21162182

* `offset` {Integer} Where to start writing. Must satisfy: `0 <= offset <= buf.length - 2`

@@ -2145,6 +2211,9 @@ console.log(buf);

2145221121462212

### buf.writeUInt32BE(value, offset[, noAssert])

21472213

### buf.writeUInt32LE(value, offset[, noAssert])

2214+

<!-- YAML

2215+

added: v0.5.5

2216+

-->

2148221721492218

* `value` {Integer} Number to be written to `buf`

21502219

* `offset` {Integer} Where to start writing. Must satisfy: `0 <= offset <= buf.length - 4`

@@ -2177,6 +2246,9 @@ console.log(buf);

2177224621782247

### buf.writeUIntBE(value, offset, byteLength[, noAssert])

21792248

### buf.writeUIntLE(value, offset, byteLength[, noAssert])

2249+

<!-- YAML

2250+

added: v0.5.5

2251+

-->

2180225221812253

* `value` {Integer} Number to be written to `buf`

21822254

* `offset` {Integer} Where to start writing. Must satisfy: `0 <= offset <= buf.length - byteLength`

@@ -2209,6 +2281,9 @@ console.log(buf);

22092281

```

2210228222112283

## buffer.INSPECT_MAX_BYTES

2284+

<!-- YAML

2285+

added: v0.5.4

2286+

-->

2212228722132288

* {Integer} **Default:** `50`

22142289