Skip to content

Commit 3567ff1

Browse files
vsemozhetbytBethGriggs
authored andcommitted
doc: mark optional parameters in buffer.md
PR-URL: #27030 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Signed-off-by: Beth Griggs <Bethany.Griggs@uk.ibm.com>
1 parent eeee636 commit 3567ff1

File tree

1 file changed

+44
-44
lines changed

1 file changed

+44
-44
lines changed

doc/api/buffer.md

+44-44
Original file line numberDiff line numberDiff line change
@@ -1541,8 +1541,8 @@ deprecated: v8.0.0
15411541
15421542
The `buf.parent` property is a deprecated alias for `buf.buffer`.
15431543

1544-
### buf.readDoubleBE(offset)
1545-
### buf.readDoubleLE(offset)
1544+
### buf.readDoubleBE([offset])
1545+
### buf.readDoubleLE([offset])
15461546
<!-- YAML
15471547
added: v0.11.15
15481548
changes:
@@ -1553,7 +1553,7 @@ changes:
15531553
-->
15541554

15551555
* `offset` {integer} Number of bytes to skip before starting to read. Must
1556-
satisfy `0 <= offset <= buf.length - 8`.
1556+
satisfy `0 <= offset <= buf.length - 8`. **Default:** `0`.
15571557
* Returns: {number}
15581558

15591559
Reads a 64-bit double from `buf` at the specified `offset` with specified
@@ -1571,8 +1571,8 @@ console.log(buf.readDoubleLE(1));
15711571
// Throws ERR_OUT_OF_RANGE
15721572
```
15731573

1574-
### buf.readFloatBE(offset)
1575-
### buf.readFloatLE(offset)
1574+
### buf.readFloatBE([offset])
1575+
### buf.readFloatLE([offset])
15761576
<!-- YAML
15771577
added: v0.11.15
15781578
changes:
@@ -1583,7 +1583,7 @@ changes:
15831583
-->
15841584

15851585
* `offset` {integer} Number of bytes to skip before starting to read. Must
1586-
satisfy `0 <= offset <= buf.length - 4`.
1586+
satisfy `0 <= offset <= buf.length - 4`. **Default:** `0`.
15871587
* Returns: {number}
15881588

15891589
Reads a 32-bit float from `buf` at the specified `offset` with specified
@@ -1601,7 +1601,7 @@ console.log(buf.readFloatLE(1));
16011601
// Throws ERR_OUT_OF_RANGE
16021602
```
16031603

1604-
### buf.readInt8(offset)
1604+
### buf.readInt8([offset])
16051605
<!-- YAML
16061606
added: v0.5.0
16071607
changes:
@@ -1612,7 +1612,7 @@ changes:
16121612
-->
16131613

16141614
* `offset` {integer} Number of bytes to skip before starting to read. Must
1615-
satisfy `0 <= offset <= buf.length - 1`.
1615+
satisfy `0 <= offset <= buf.length - 1`. **Default:** `0`.
16161616
* Returns: {integer}
16171617

16181618
Reads a signed 8-bit integer from `buf` at the specified `offset`.
@@ -1630,8 +1630,8 @@ console.log(buf.readInt8(2));
16301630
// Throws ERR_OUT_OF_RANGE
16311631
```
16321632

1633-
### buf.readInt16BE(offset)
1634-
### buf.readInt16LE(offset)
1633+
### buf.readInt16BE([offset])
1634+
### buf.readInt16LE([offset])
16351635
<!-- YAML
16361636
added: v0.5.5
16371637
changes:
@@ -1642,7 +1642,7 @@ changes:
16421642
-->
16431643

16441644
* `offset` {integer} Number of bytes to skip before starting to read. Must
1645-
satisfy `0 <= offset <= buf.length - 2`.
1645+
satisfy `0 <= offset <= buf.length - 2`. **Default:** `0`.
16461646
* Returns: {integer}
16471647

16481648
Reads a signed 16-bit integer from `buf` at the specified `offset` with
@@ -1662,8 +1662,8 @@ console.log(buf.readInt16LE(1));
16621662
// Throws ERR_OUT_OF_RANGE
16631663
```
16641664

1665-
### buf.readInt32BE(offset)
1666-
### buf.readInt32LE(offset)
1665+
### buf.readInt32BE([offset])
1666+
### buf.readInt32LE([offset])
16671667
<!-- YAML
16681668
added: v0.5.5
16691669
changes:
@@ -1674,7 +1674,7 @@ changes:
16741674
-->
16751675

16761676
* `offset` {integer} Number of bytes to skip before starting to read. Must
1677-
satisfy `0 <= offset <= buf.length - 4`.
1677+
satisfy `0 <= offset <= buf.length - 4`. **Default:** `0`.
16781678
* Returns: {integer}
16791679

16801680
Reads a signed 32-bit integer from `buf` at the specified `offset` with
@@ -1728,7 +1728,7 @@ console.log(buf.readIntBE(1, 0).toString(16));
17281728
// Throws ERR_OUT_OF_RANGE
17291729
```
17301730

1731-
### buf.readUInt8(offset)
1731+
### buf.readUInt8([offset])
17321732
<!-- YAML
17331733
added: v0.5.0
17341734
changes:
@@ -1739,7 +1739,7 @@ changes:
17391739
-->
17401740

17411741
* `offset` {integer} Number of bytes to skip before starting to read. Must
1742-
satisfy `0 <= offset <= buf.length - 1`.
1742+
satisfy `0 <= offset <= buf.length - 1`. **Default:** `0`.
17431743
* Returns: {integer}
17441744

17451745
Reads an unsigned 8-bit integer from `buf` at the specified `offset`.
@@ -1755,8 +1755,8 @@ console.log(buf.readUInt8(2));
17551755
// Throws ERR_OUT_OF_RANGE
17561756
```
17571757

1758-
### buf.readUInt16BE(offset)
1759-
### buf.readUInt16LE(offset)
1758+
### buf.readUInt16BE([offset])
1759+
### buf.readUInt16LE([offset])
17601760
<!-- YAML
17611761
added: v0.5.5
17621762
changes:
@@ -1767,7 +1767,7 @@ changes:
17671767
-->
17681768

17691769
* `offset` {integer} Number of bytes to skip before starting to read. Must
1770-
satisfy `0 <= offset <= buf.length - 2`.
1770+
satisfy `0 <= offset <= buf.length - 2`. **Default:** `0`.
17711771
* Returns: {integer}
17721772

17731773
Reads an unsigned 16-bit integer from `buf` at the specified `offset` with
@@ -1789,8 +1789,8 @@ console.log(buf.readUInt16LE(2).toString(16));
17891789
// Throws ERR_OUT_OF_RANGE
17901790
```
17911791

1792-
### buf.readUInt32BE(offset)
1793-
### buf.readUInt32LE(offset)
1792+
### buf.readUInt32BE([offset])
1793+
### buf.readUInt32LE([offset])
17941794
<!-- YAML
17951795
added: v0.5.5
17961796
changes:
@@ -1801,7 +1801,7 @@ changes:
18011801
-->
18021802

18031803
* `offset` {integer} Number of bytes to skip before starting to read. Must
1804-
satisfy `0 <= offset <= buf.length - 4`.
1804+
satisfy `0 <= offset <= buf.length - 4`. **Default:** `0`.
18051805
* Returns: {integer}
18061806

18071807
Reads an unsigned 32-bit integer from `buf` at the specified `offset` with
@@ -2144,8 +2144,8 @@ console.log(`${len} bytes: ${buf.toString('utf8', 0, len)}`);
21442144
// Prints: 12 bytes: ½ + ¼ = ¾
21452145
```
21462146

2147-
### buf.writeDoubleBE(value, offset)
2148-
### buf.writeDoubleLE(value, offset)
2147+
### buf.writeDoubleBE(value[, offset])
2148+
### buf.writeDoubleLE(value[, offset])
21492149
<!-- YAML
21502150
added: v0.11.15
21512151
changes:
@@ -2157,7 +2157,7 @@ changes:
21572157

21582158
* `value` {number} Number to be written to `buf`.
21592159
* `offset` {integer} Number of bytes to skip before starting to write. Must
2160-
satisfy `0 <= offset <= buf.length - 8`.
2160+
satisfy `0 <= offset <= buf.length - 8`. **Default:** `0`.
21612161
* Returns: {integer} `offset` plus the number of bytes written.
21622162

21632163
Writes `value` to `buf` at the specified `offset` with specified endian
@@ -2179,8 +2179,8 @@ console.log(buf);
21792179
// Prints: <Buffer 77 be 9f 1a 2f dd 5e 40>
21802180
```
21812181

2182-
### buf.writeFloatBE(value, offset)
2183-
### buf.writeFloatLE(value, offset)
2182+
### buf.writeFloatBE(value[, offset])
2183+
### buf.writeFloatLE(value[, offset])
21842184
<!-- YAML
21852185
added: v0.11.15
21862186
changes:
@@ -2192,7 +2192,7 @@ changes:
21922192

21932193
* `value` {number} Number to be written to `buf`.
21942194
* `offset` {integer} Number of bytes to skip before starting to write. Must
2195-
satisfy `0 <= offset <= buf.length - 4`.
2195+
satisfy `0 <= offset <= buf.length - 4`. **Default:** `0`.
21962196
* Returns: {integer} `offset` plus the number of bytes written.
21972197

21982198
Writes `value` to `buf` at the specified `offset` with specified endian
@@ -2214,7 +2214,7 @@ console.log(buf);
22142214
// Prints: <Buffer bb fe 4a 4f>
22152215
```
22162216

2217-
### buf.writeInt8(value, offset)
2217+
### buf.writeInt8(value[, offset])
22182218
<!-- YAML
22192219
added: v0.5.0
22202220
changes:
@@ -2226,7 +2226,7 @@ changes:
22262226

22272227
* `value` {integer} Number to be written to `buf`.
22282228
* `offset` {integer} Number of bytes to skip before starting to write. Must
2229-
satisfy `0 <= offset <= buf.length - 1`.
2229+
satisfy `0 <= offset <= buf.length - 1`. **Default:** `0`.
22302230
* Returns: {integer} `offset` plus the number of bytes written.
22312231

22322232
Writes `value` to `buf` at the specified `offset`. `value` *should* be a valid
@@ -2245,8 +2245,8 @@ console.log(buf);
22452245
// Prints: <Buffer 02 fe>
22462246
```
22472247

2248-
### buf.writeInt16BE(value, offset)
2249-
### buf.writeInt16LE(value, offset)
2248+
### buf.writeInt16BE(value[, offset])
2249+
### buf.writeInt16LE(value[, offset])
22502250
<!-- YAML
22512251
added: v0.5.5
22522252
changes:
@@ -2258,7 +2258,7 @@ changes:
22582258

22592259
* `value` {integer} Number to be written to `buf`.
22602260
* `offset` {integer} Number of bytes to skip before starting to write. Must
2261-
satisfy `0 <= offset <= buf.length - 2`.
2261+
satisfy `0 <= offset <= buf.length - 2`. **Default:** `0`.
22622262
* Returns: {integer} `offset` plus the number of bytes written.
22632263

22642264
Writes `value` to `buf` at the specified `offset` with specified endian
@@ -2278,8 +2278,8 @@ console.log(buf);
22782278
// Prints: <Buffer 01 02 04 03>
22792279
```
22802280

2281-
### buf.writeInt32BE(value, offset)
2282-
### buf.writeInt32LE(value, offset)
2281+
### buf.writeInt32BE(value[, offset])
2282+
### buf.writeInt32LE(value[, offset])
22832283
<!-- YAML
22842284
added: v0.5.5
22852285
changes:
@@ -2291,7 +2291,7 @@ changes:
22912291

22922292
* `value` {integer} Number to be written to `buf`.
22932293
* `offset` {integer} Number of bytes to skip before starting to write. Must
2294-
satisfy `0 <= offset <= buf.length - 4`.
2294+
satisfy `0 <= offset <= buf.length - 4`. **Default:** `0`.
22952295
* Returns: {integer} `offset` plus the number of bytes written.
22962296

22972297
Writes `value` to `buf` at the specified `offset` with specified endian
@@ -2347,7 +2347,7 @@ console.log(buf);
23472347
// Prints: <Buffer ab 90 78 56 34 12>
23482348
```
23492349

2350-
### buf.writeUInt8(value, offset)
2350+
### buf.writeUInt8(value[, offset])
23512351
<!-- YAML
23522352
added: v0.5.0
23532353
changes:
@@ -2359,7 +2359,7 @@ changes:
23592359

23602360
* `value` {integer} Number to be written to `buf`.
23612361
* `offset` {integer} Number of bytes to skip before starting to write. Must
2362-
satisfy `0 <= offset <= buf.length - 1`.
2362+
satisfy `0 <= offset <= buf.length - 1`. **Default:** `0`.
23632363
* Returns: {integer} `offset` plus the number of bytes written.
23642364

23652365
Writes `value` to `buf` at the specified `offset`. `value` *should* be a
@@ -2378,8 +2378,8 @@ console.log(buf);
23782378
// Prints: <Buffer 03 04 23 42>
23792379
```
23802380

2381-
### buf.writeUInt16BE(value, offset)
2382-
### buf.writeUInt16LE(value, offset)
2381+
### buf.writeUInt16BE(value[, offset])
2382+
### buf.writeUInt16LE(value[, offset])
23832383
<!-- YAML
23842384
added: v0.5.5
23852385
changes:
@@ -2391,7 +2391,7 @@ changes:
23912391

23922392
* `value` {integer} Number to be written to `buf`.
23932393
* `offset` {integer} Number of bytes to skip before starting to write. Must
2394-
satisfy `0 <= offset <= buf.length - 2`.
2394+
satisfy `0 <= offset <= buf.length - 2`. **Default:** `0`.
23952395
* Returns: {integer} `offset` plus the number of bytes written.
23962396

23972397
Writes `value` to `buf` at the specified `offset` with specified endian
@@ -2415,8 +2415,8 @@ console.log(buf);
24152415
// Prints: <Buffer ad de ef be>
24162416
```
24172417

2418-
### buf.writeUInt32BE(value, offset)
2419-
### buf.writeUInt32LE(value, offset)
2418+
### buf.writeUInt32BE(value[, offset])
2419+
### buf.writeUInt32LE(value[, offset])
24202420
<!-- YAML
24212421
added: v0.5.5
24222422
changes:
@@ -2428,7 +2428,7 @@ changes:
24282428

24292429
* `value` {integer} Number to be written to `buf`.
24302430
* `offset` {integer} Number of bytes to skip before starting to write. Must
2431-
satisfy `0 <= offset <= buf.length - 4`.
2431+
satisfy `0 <= offset <= buf.length - 4`. **Default:** `0`.
24322432
* Returns: {integer} `offset` plus the number of bytes written.
24332433

24342434
Writes `value` to `buf` at the specified `offset` with specified endian

0 commit comments

Comments
 (0)