Skip to content

Commit 0d75adc

Browse files
vsemozhetbytBethGriggs
authored andcommitted
doc: add missing types 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 231eff9 commit 0d75adc

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

doc/api/buffer.md

+9-6
Original file line numberDiff line numberDiff line change
@@ -515,8 +515,8 @@ changes:
515515
-->
516516

517517
* `size` {integer} The desired length of the new `Buffer`.
518-
* `fill` {string|Buffer|integer} A value to pre-fill the new `Buffer` with.
519-
**Default:** `0`.
518+
* `fill` {string|Buffer|Uint8Array|integer} A value to pre-fill the new `Buffer`
519+
with. **Default:** `0`.
520520
* `encoding` {string} If `fill` is a string, this is its encoding.
521521
**Default:** `'utf8'`.
522522

@@ -958,6 +958,8 @@ type: property
958958
name: [index]
959959
-->
960960

961+
* `index` {integer}
962+
961963
The index operator `[index]` can be used to get and set the octet at position
962964
`index` in `buf`. The values refer to individual bytes, so the legal value
963965
range is between `0x00` and `0xFF` (hex) or `0` and `255` (decimal).
@@ -1176,8 +1178,8 @@ changes:
11761178
description: The arguments can now be `Uint8Array`s.
11771179
-->
11781180

1179-
* `otherBuffer` {Buffer} A `Buffer` or [`Uint8Array`] with which to compare
1180-
`buf`.
1181+
* `otherBuffer` {Buffer|Uint8Array} A `Buffer` or [`Uint8Array`] with which to
1182+
compare `buf`.
11811183
* Returns: {boolean}
11821184

11831185
Returns `true` if both `buf` and `otherBuffer` have exactly the same bytes,
@@ -1217,7 +1219,7 @@ changes:
12171219
description: The `encoding` parameter is supported now.
12181220
-->
12191221

1220-
* `value` {string|Buffer|integer} The value with which to fill `buf`.
1222+
* `value` {string|Buffer|Uint8Array|integer} The value with which to fill `buf`.
12211223
* `offset` {integer} Number of bytes to skip before starting to fill `buf`.
12221224
**Default:** `0`.
12231225
* `end` {integer} Where to stop filling `buf` (not inclusive). **Default:**
@@ -1271,7 +1273,7 @@ console.log(buf.fill('zz', 'hex'));
12711273
added: v5.3.0
12721274
-->
12731275

1274-
* `value` {string|Buffer|integer} What to search for.
1276+
* `value` {string|Buffer|Uint8Array|integer} What to search for.
12751277
* `byteOffset` {integer} Where to begin searching in `buf`. **Default:** `0`.
12761278
* `encoding` {string} If `value` is a string, this is its encoding.
12771279
**Default:** `'utf8'`.
@@ -2515,6 +2517,7 @@ changes:
25152517
* `source` {Buffer|Uint8Array} A `Buffer` or `Uint8Array` instance.
25162518
* `fromEnc` {string} The current encoding.
25172519
* `toEnc` {string} To target encoding.
2520+
* Returns: {Buffer}
25182521

25192522
Re-encodes the given `Buffer` or `Uint8Array` instance from one character
25202523
encoding to another. Returns a new `Buffer` instance.

0 commit comments

Comments
 (0)