@@ -612,7 +612,7 @@ added: v0.1.90
612612 calculate the length of
613613* ` encoding ` {String} If ` string ` is a string, this is its encoding.
614614 ** Default:** ` 'utf8' `
615- * Return : {Integer} The number of bytes contained within ` string `
615+ * Returns : {Integer} The number of bytes contained within ` string `
616616
617617Returns the actual byte length of a string. This is not the same as
618618[ ` String.prototype.length ` ] since that returns the number of * characters* in
@@ -638,7 +638,7 @@ added: v0.11.13
638638
639639* ` buf1 ` {Buffer}
640640* ` buf2 ` {Buffer}
641- * Return : {Integer}
641+ * Returns : {Integer}
642642
643643Compares ` buf1 ` to ` buf2 ` typically for the purpose of sorting arrays of
644644` Buffer ` instances. This is equivalent to calling
@@ -664,7 +664,7 @@ added: v0.7.11
664664* ` list ` {Array} List of ` Buffer ` instances to concat
665665* ` totalLength ` {Integer} Total length of the ` Buffer ` instances in ` list `
666666 when concatenated
667- * Return : {Buffer}
667+ * Returns : {Buffer}
668668
669669Returns a new ` Buffer ` which is the result of concatenating all the ` Buffer `
670670instances in the ` list ` together.
@@ -829,7 +829,7 @@ added: v0.1.101
829829-->
830830
831831* ` obj ` {Object}
832- * Return : {Boolean}
832+ * Returns : {Boolean}
833833
834834Returns ` true ` if ` obj ` is a ` Buffer ` , ` false ` otherwise.
835835
@@ -839,7 +839,7 @@ added: v0.9.1
839839-->
840840
841841* ` encoding ` {String} A character encoding name to check
842- * Return : {Boolean}
842+ * Returns : {Boolean}
843843
844844Returns ` true ` if ` encoding ` contains a supported character encoding, or ` false `
845845otherwise.
@@ -894,7 +894,7 @@ added: v0.11.13
894894* ` sourceEnd ` {Integer} The offset within ` buf ` at which to end comparison
895895 (not inclusive). Ignored when ` targetStart ` is ` undefined ` .
896896 ** Default:** [ ` buf.length ` ]
897- * Return : {Integer}
897+ * Returns : {Integer}
898898
899899Compares ` buf ` with ` target ` and returns a number indicating whether ` buf `
900900comes before, after, or is the same as ` target ` in sort order.
@@ -966,7 +966,7 @@ added: v0.1.90
966966 Ignored when ` targetStart ` is ` undefined ` . ** Default:** ` 0 `
967967* ` sourceEnd ` {Integer} The offset within ` buf ` at which to stop copying (not
968968 inclusive). Ignored when ` sourceStart ` is ` undefined ` . ** Default:** [ ` buf.length ` ]
969- * Return : {Integer} The number of bytes copied.
969+ * Returns : {Integer} The number of bytes copied.
970970
971971Copies data from a region of ` buf ` to a region in ` target ` even if the ` target `
972972memory region overlaps with ` buf ` .
@@ -1011,7 +1011,7 @@ console.log(buf.toString());
10111011added: v1.1.0
10121012-->
10131013
1014- * Return : {Iterator}
1014+ * Returns : {Iterator}
10151015
10161016Creates and returns an [ iterator] of ` [index, byte] ` pairs from the contents of
10171017` buf ` .
@@ -1039,7 +1039,7 @@ added: v0.11.13
10391039-->
10401040
10411041* ` otherBuffer ` {Buffer} A ` Buffer ` to compare to
1042- * Return : {Boolean}
1042+ * Returns : {Boolean}
10431043
10441044Returns ` true ` if both ` buf ` and ` otherBuffer ` have exactly the same bytes,
10451045` false ` otherwise.
@@ -1068,7 +1068,7 @@ added: v0.5.0
10681068* ` end ` {Integer} Where to stop filling ` buf ` (not inclusive). ** Default:** [ ` buf.length ` ]
10691069* ` encoding ` {String} If ` value ` is a string, this is its encoding.
10701070 ** Default:** ` 'utf8' `
1071- * Return : {Buffer} A reference to ` buf `
1071+ * Returns : {Buffer} A reference to ` buf `
10721072
10731073Fills ` buf ` with the specified ` value ` . If the ` offset ` and ` end ` are not given,
10741074the entire ` buf ` will be filled. This is meant to be a small simplification to
@@ -1104,7 +1104,7 @@ added: v1.5.0
11041104* ` byteOffset ` {Integer} Where to begin searching in ` buf ` . ** Default:** ` 0 `
11051105* ` encoding ` {String} If ` value ` is a string, this is its encoding.
11061106 ** Default:** ` 'utf8' `
1107- * Return : {Integer} The index of the first occurrence of ` value ` in ` buf ` or ` -1 `
1107+ * Returns : {Integer} The index of the first occurrence of ` value ` in ` buf ` or ` -1 `
11081108 if ` buf ` does not contain ` value `
11091109
11101110If ` value ` is:
@@ -1159,7 +1159,7 @@ added: v5.3.0
11591159* ` byteOffset ` {Integer} Where to begin searching in ` buf ` . ** Default:** ` 0 `
11601160* ` encoding ` {String} If ` value ` is a string, this is its encoding.
11611161 ** Default:** ` 'utf8' `
1162- * Return : {Boolean} ` true ` if ` value ` was found in ` buf ` , ` false ` otherwise
1162+ * Returns : {Boolean} ` true ` if ` value ` was found in ` buf ` , ` false ` otherwise
11631163
11641164Equivalent to [ ` buf.indexOf() !== -1 ` ] [ `buf.indexOf()` ] .
11651165
@@ -1196,7 +1196,7 @@ console.log(buf.includes('this', 4));
11961196added: v1.1.0
11971197-->
11981198
1199- * Return : {Iterator}
1199+ * Returns : {Iterator}
12001200
12011201Creates and returns an [ iterator] of ` buf ` keys (indices).
12021202
@@ -1227,7 +1227,7 @@ added: v6.0.0
12271227 ** Default:** [ ` buf.length ` ]
12281228* ` encoding ` {String} If ` value ` is a string, this is its encoding.
12291229 ** Default:** ` 'utf8' `
1230- * Return : {Integer} The index of the last occurrence of ` value ` in ` buf ` or ` -1 `
1230+ * Returns : {Integer} The index of the last occurrence of ` value ` in ` buf ` or ` -1 `
12311231 if ` buf ` does not contain ` value `
12321232
12331233Identical to [ ` buf.indexOf() ` ] , except ` buf ` is searched from back to front
@@ -1323,7 +1323,7 @@ added: v0.11.15
13231323
13241324* ` offset ` {Integer} Where to start reading. Must satisfy: ` 0 <= offset <= buf.length - 8 `
13251325* ` noAssert ` {Boolean} Skip ` offset ` validation? ** Default:** ` false `
1326- * Return : {Number}
1326+ * Returns : {Number}
13271327
13281328Reads a 64-bit double from ` buf ` at the specified ` offset ` with specified
13291329endian format (` readDoubleBE() ` returns big endian, ` readDoubleLE() ` returns
@@ -1359,7 +1359,7 @@ added: v0.11.15
13591359
13601360* ` offset ` {Integer} Where to start reading. Must satisfy: ` 0 <= offset <= buf.length - 4 `
13611361* ` noAssert ` {Boolean} Skip ` offset ` validation? ** Default:** ` false `
1362- * Return : {Number}
1362+ * Returns : {Number}
13631363
13641364Reads a 32-bit float from ` buf ` at the specified ` offset ` with specified
13651365endian format (` readFloatBE() ` returns big endian, ` readFloatLE() ` returns
@@ -1394,7 +1394,7 @@ added: v0.5.0
13941394
13951395* ` offset ` {Integer} Where to start reading. Must satisfy: ` 0 <= offset <= buf.length - 1 `
13961396* ` noAssert ` {Boolean} Skip ` offset ` validation? ** Default:** ` false `
1397- * Return : {Integer}
1397+ * Returns : {Integer}
13981398
13991399Reads a signed 8-bit integer from ` buf ` at the specified ` offset ` .
14001400
@@ -1426,7 +1426,7 @@ added: v0.5.5
14261426
14271427* ` offset ` {Integer} Where to start reading. Must satisfy: ` 0 <= offset <= buf.length - 2 `
14281428* ` noAssert ` {Boolean} Skip ` offset ` validation? ** Default:** ` false `
1429- * Return : {Integer}
1429+ * Returns : {Integer}
14301430
14311431Reads a signed 16-bit integer from ` buf ` at the specified ` offset ` with
14321432the specified endian format (` readInt16BE() ` returns big endian,
@@ -1460,7 +1460,7 @@ added: v0.5.5
14601460
14611461* ` offset ` {Integer} Where to start reading. Must satisfy: ` 0 <= offset <= buf.length - 4 `
14621462* ` noAssert ` {Boolean} Skip ` offset ` validation? ** Default:** ` false `
1463- * Return : {Integer}
1463+ * Returns : {Integer}
14641464
14651465Reads a signed 32-bit integer from ` buf ` at the specified ` offset ` with
14661466the specified endian format (` readInt32BE() ` returns big endian,
@@ -1495,7 +1495,7 @@ added: v0.11.15
14951495* ` offset ` {Integer} Where to start reading. Must satisfy: ` 0 <= offset <= buf.length - byteLength `
14961496* ` byteLength ` {Integer} How many bytes to read. Must satisfy: ` 0 < byteLength <= 6 `
14971497* ` noAssert ` {Boolean} Skip ` offset ` and ` byteLength ` validation? ** Default:** ` false `
1498- * Return : {Integer}
1498+ * Returns : {Integer}
14991499
15001500Reads ` byteLength ` number of bytes from ` buf ` at the specified ` offset `
15011501and interprets the result as a two's complement signed value. Supports up to 48
@@ -1526,7 +1526,7 @@ added: v0.5.0
15261526
15271527* ` offset ` {Integer} Where to start reading. Must satisfy: ` 0 <= offset <= buf.length - 1 `
15281528* ` noAssert ` {Boolean} Skip ` offset ` validation? ** Default:** ` false `
1529- * Return : {Integer}
1529+ * Returns : {Integer}
15301530
15311531Reads an unsigned 8-bit integer from ` buf ` at the specified ` offset ` .
15321532
@@ -1556,7 +1556,7 @@ added: v0.5.5
15561556
15571557* ` offset ` {Integer} Where to start reading. Must satisfy: ` 0 <= offset <= buf.length - 2 `
15581558* ` noAssert ` {Boolean} Skip ` offset ` validation? ** Default:** ` false `
1559- * Return : {Integer}
1559+ * Returns : {Integer}
15601560
15611561Reads an unsigned 16-bit integer from ` buf ` at the specified ` offset ` with
15621562specified endian format (` readUInt16BE() ` returns big endian, ` readUInt16LE() `
@@ -1594,7 +1594,7 @@ added: v0.5.5
15941594
15951595* ` offset ` {Integer} Where to start reading. Must satisfy: ` 0 <= offset <= buf.length - 4 `
15961596* ` noAssert ` {Boolean} Skip ` offset ` validation? ** Default:** ` false `
1597- * Return : {Integer}
1597+ * Returns : {Integer}
15981598
15991599Reads an unsigned 32-bit integer from ` buf ` at the specified ` offset ` with
16001600specified endian format (` readUInt32BE() ` returns big endian,
@@ -1627,7 +1627,7 @@ added: v0.11.15
16271627* ` offset ` {Integer} Where to start reading. Must satisfy: ` 0 <= offset <= buf.length - byteLength `
16281628* ` byteLength ` {Integer} How many bytes to read. Must satisfy: ` 0 < byteLength <= 6 `
16291629* ` noAssert ` {Boolean} Skip ` offset ` and ` byteLength ` validation? ** Default:** ` false `
1630- * Return : {Integer}
1630+ * Returns : {Integer}
16311631
16321632Reads ` byteLength ` number of bytes from ` buf ` at the specified ` offset `
16331633and interprets the result as an unsigned integer. Supports up to 48
@@ -1659,7 +1659,7 @@ added: v0.3.0
16591659* ` start ` {Integer} Where the new ` Buffer ` will start. ** Default:** ` 0 `
16601660* ` end ` {Integer} Where the new ` Buffer ` will end (not inclusive).
16611661 ** Default:** [ ` buf.length ` ]
1662- * Return : {Buffer}
1662+ * Returns : {Buffer}
16631663
16641664Returns a new ` Buffer ` that references the same memory as the original, but
16651665offset and cropped by the ` start ` and ` end ` indices.
@@ -1715,7 +1715,7 @@ console.log(buf.slice(-5, -2).toString());
17151715added: v5.10.0
17161716-->
17171717
1718- * Return : {Buffer} A reference to ` buf `
1718+ * Returns : {Buffer} A reference to ` buf `
17191719
17201720Interprets ` buf ` as an array of unsigned 16-bit integers and swaps the byte-order
17211721* in-place* . Throws a ` RangeError ` if [ ` buf.length ` ] is not a multiple of 2.
@@ -1745,7 +1745,7 @@ buf2.swap32();
17451745added: v5.10.0
17461746-->
17471747
1748- * Return : {Buffer} A reference to ` buf `
1748+ * Returns : {Buffer} A reference to ` buf `
17491749
17501750Interprets ` buf ` as an array of unsigned 32-bit integers and swaps the byte-order
17511751* in-place* . Throws a ` RangeError ` if [ ` buf.length ` ] is not a multiple of 4.
@@ -1775,7 +1775,7 @@ buf2.swap32();
17751775added: v6.3.0
17761776-->
17771777
1778- * Return : {Buffer} A reference to ` buf `
1778+ * Returns : {Buffer} A reference to ` buf `
17791779
17801780Interprets ` buf ` as an array of 64-bit numbers and swaps the byte-order * in-place* .
17811781Throws a ` RangeError ` if [ ` buf.length ` ] is not a multiple of 8.
@@ -1812,7 +1812,7 @@ added: v0.1.90
18121812* ` start ` {Integer} The byte offset to start decoding at. ** Default:** ` 0 `
18131813* ` end ` {Integer} The byte offset to stop decoding at (not inclusive).
18141814 ** Default:** [ ` buf.length ` ]
1815- * Return : {String}
1815+ * Returns : {String}
18161816
18171817Decodes ` buf ` to a string according to the specified character encoding in
18181818` encoding ` . ` start ` and ` end ` may be passed to decode only a subset of ` buf ` .
@@ -1851,7 +1851,7 @@ console.log(buf2.toString(undefined, 0, 3));
18511851added: v0.9.2
18521852-->
18531853
1854- * Return : {Object}
1854+ * Returns : {Object}
18551855
18561856Returns a JSON representation of ` buf ` . [ ` JSON.stringify() ` ] implicitly calls
18571857this function when stringifying a ` Buffer ` instance.
@@ -1880,7 +1880,7 @@ console.log(copy);
18801880added: v1.1.0
18811881-->
18821882
1883- * Return : {Iterator}
1883+ * Returns : {Iterator}
18841884
18851885Creates and returns an [ iterator] for ` buf ` values (bytes). This function is
18861886called automatically when a ` Buffer ` is used in a ` for..of ` statement.
@@ -1922,7 +1922,7 @@ added: v0.1.90
19221922* ` offset ` {Integer} Where to start writing ` string ` . ** Default:** ` 0 `
19231923* ` length ` {Integer} How many bytes to write. ** Default:** ` buf.length - offset `
19241924* ` encoding ` {String} The character encoding of ` string ` . ** Default:** ` 'utf8' `
1925- * Return : {Integer} Number of bytes written
1925+ * Returns : {Integer} Number of bytes written
19261926
19271927Writes ` string ` to ` buf ` at ` offset ` according to the character encoding in ` encoding ` .
19281928The ` length ` parameter is the number of bytes to write. If ` buf ` did not contain
@@ -1949,7 +1949,7 @@ added: v0.11.15
19491949* ` value ` {Number} Number to be written to ` buf `
19501950* ` offset ` {Integer} Where to start writing. Must satisfy: ` 0 <= offset <= buf.length - 8 `
19511951* ` noAssert ` {Boolean} Skip ` value ` and ` offset ` validation? ** Default:** ` false `
1952- * Return : {Integer} ` offset ` plus the number of bytes written
1952+ * Returns : {Integer} ` offset ` plus the number of bytes written
19531953
19541954Writes ` value ` to ` buf ` at the specified ` offset ` with specified endian
19551955format (` writeDoubleBE() ` writes big endian, ` writeDoubleLE() ` writes little
@@ -1984,7 +1984,7 @@ added: v0.11.15
19841984* ` value ` {Number} Number to be written to ` buf `
19851985* ` offset ` {Integer} Where to start writing. Must satisfy: ` 0 <= offset <= buf.length - 4 `
19861986* ` noAssert ` {Boolean} Skip ` value ` and ` offset ` validation? ** Default:** ` false `
1987- * Return : {Integer} ` offset ` plus the number of bytes written
1987+ * Returns : {Integer} ` offset ` plus the number of bytes written
19881988
19891989Writes ` value ` to ` buf ` at the specified ` offset ` with specified endian
19901990format (` writeFloatBE() ` writes big endian, ` writeFloatLE() ` writes little
@@ -2018,7 +2018,7 @@ added: v0.5.0
20182018* ` value ` {Integer} Number to be written to ` buf `
20192019* ` offset ` {Integer} Where to start writing. Must satisfy: ` 0 <= offset <= buf.length - 1 `
20202020* ` noAssert ` {Boolean} Skip ` value ` and ` offset ` validation? ** Default:** ` false `
2021- * Return : {Integer} ` offset ` plus the number of bytes written
2021+ * Returns : {Integer} ` offset ` plus the number of bytes written
20222022
20232023Writes ` value ` to ` buf ` at the specified ` offset ` . ` value ` * should* be a valid
20242024signed 8-bit integer. Behavior is undefined when ` value ` is anything other than
@@ -2050,7 +2050,7 @@ added: v0.5.5
20502050* ` value ` {Integer} Number to be written to ` buf `
20512051* ` offset ` {Integer} Where to start writing. Must satisfy: ` 0 <= offset <= buf.length - 2 `
20522052* ` noAssert ` {Boolean} Skip ` value ` and ` offset ` validation? ** Default:** ` false `
2053- * Return : {Integer} ` offset ` plus the number of bytes written
2053+ * Returns : {Integer} ` offset ` plus the number of bytes written
20542054
20552055Writes ` value ` to ` buf ` at the specified ` offset ` with specified endian
20562056format (` writeInt16BE() ` writes big endian, ` writeInt16LE() ` writes little
@@ -2083,7 +2083,7 @@ added: v0.5.5
20832083* ` value ` {Integer} Number to be written to ` buf `
20842084* ` offset ` {Integer} Where to start writing. Must satisfy: ` 0 <= offset <= buf.length - 4 `
20852085* ` noAssert ` {Boolean} Skip ` value ` and ` offset ` validation? ** Default:** ` false `
2086- * Return : {Integer} ` offset ` plus the number of bytes written
2086+ * Returns : {Integer} ` offset ` plus the number of bytes written
20872087
20882088Writes ` value ` to ` buf ` at the specified ` offset ` with specified endian
20892089format (` writeInt32BE() ` writes big endian, ` writeInt32LE() ` writes little
@@ -2118,7 +2118,7 @@ added: v0.11.15
21182118* ` byteLength ` {Integer} How many bytes to write. Must satisfy: ` 0 < byteLength <= 6 `
21192119* ` noAssert ` {Boolean} Skip ` value ` , ` offset ` , and ` byteLength ` validation?
21202120 ** Default:** ` false `
2121- * Return : {Integer} ` offset ` plus the number of bytes written
2121+ * Returns : {Integer} ` offset ` plus the number of bytes written
21222122
21232123Writes ` byteLength ` bytes of ` value ` to ` buf ` at the specified ` offset ` .
21242124Supports up to 48 bits of accuracy. Behavior is undefined when ` value ` is
@@ -2151,7 +2151,7 @@ added: v0.5.0
21512151* ` value ` {Integer} Number to be written to ` buf `
21522152* ` offset ` {Integer} Where to start writing. Must satisfy: ` 0 <= offset <= buf.length - 1 `
21532153* ` noAssert ` {Boolean} Skip ` value ` and ` offset ` validation? ** Default:** ` false `
2154- * Return : {Integer} ` offset ` plus the number of bytes written
2154+ * Returns : {Integer} ` offset ` plus the number of bytes written
21552155
21562156Writes ` value ` to ` buf ` at the specified ` offset ` . ` value ` * should* be a
21572157valid unsigned 8-bit integer. Behavior is undefined when ` value ` is anything
@@ -2183,7 +2183,7 @@ added: v0.5.5
21832183* ` value ` {Integer} Number to be written to ` buf `
21842184* ` offset ` {Integer} Where to start writing. Must satisfy: ` 0 <= offset <= buf.length - 2 `
21852185* ` noAssert ` {Boolean} Skip ` value ` and ` offset ` validation? ** Default:** ` false `
2186- * Return : {Integer} ` offset ` plus the number of bytes written
2186+ * Returns : {Integer} ` offset ` plus the number of bytes written
21872187
21882188Writes ` value ` to ` buf ` at the specified ` offset ` with specified endian
21892189format (` writeUInt16BE() ` writes big endian, ` writeUInt16LE() ` writes little
@@ -2220,7 +2220,7 @@ added: v0.5.5
22202220* ` value ` {Integer} Number to be written to ` buf `
22212221* ` offset ` {Integer} Where to start writing. Must satisfy: ` 0 <= offset <= buf.length - 4 `
22222222* ` noAssert ` {Boolean} Skip ` value ` and ` offset ` validation? ** Default:** ` false `
2223- * Return : {Integer} ` offset ` plus the number of bytes written
2223+ * Returns : {Integer} ` offset ` plus the number of bytes written
22242224
22252225Writes ` value ` to ` buf ` at the specified ` offset ` with specified endian
22262226format (` writeUInt32BE() ` writes big endian, ` writeUInt32LE() ` writes little
@@ -2257,7 +2257,7 @@ added: v0.5.5
22572257* ` byteLength ` {Integer} How many bytes to write. Must satisfy: ` 0 < byteLength <= 6 `
22582258* ` noAssert ` {Boolean} Skip ` value ` , ` offset ` , and ` byteLength ` validation?
22592259 ** Default:** ` false `
2260- * Return : {Integer} ` offset ` plus the number of bytes written
2260+ * Returns : {Integer} ` offset ` plus the number of bytes written
22612261
22622262Writes ` byteLength ` bytes of ` value ` to ` buf ` at the specified ` offset ` .
22632263Supports up to 48 bits of accuracy. Behavior is undefined when ` value ` is
0 commit comments