docs: TSDoc + reference of fulfillment service (#5761)

This commit is contained in:
Shahed Nasser authored and GitHub committed 2023-11-29 11:58:08 +00:00
1 parent 8f25ed8a10
commit f802e2460f
1479 files changed
+30259 -16135

No files matched your search

@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
`**[iterator]**(): [IterableIterator](../../interfaces/IterableIterator.mdx)<number>`
#### Returns
## Returns
[IterableIterator](../../interfaces/IterableIterator.mdx)<number>
@@ -36,6 +36,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Inherited from
### Inherited from
Uint8Array.[iterator]
@@ -14,7 +14,7 @@ Takes an integer value and returns the item at that index,
allowing for positive and negative integers.
Negative integers count back from the last item in the array.
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -28,7 +28,7 @@ Negative integers count back from the last item in the array.
}
]} />
#### Returns
## Returns
`undefined` \| `number`
@@ -44,6 +44,6 @@ Negative integers count back from the last item in the array.
}
]} />
#### Inherited from
### Inherited from
Uint8Array.at
@@ -57,7 +57,7 @@ console.log(buf1.compare(buf2, 5, 6, 5));
`ERR_OUT_OF_RANGE` is thrown if `targetStart < 0`, `sourceStart < 0`,`targetEnd > target.byteLength`, or `sourceEnd > source.byteLength`.
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -107,7 +107,7 @@ console.log(buf1.compare(buf2, 5, 6, 5));
}
]} />
#### Returns
## Returns
`0` \| `1` \| `-1`
@@ -123,6 +123,6 @@ console.log(buf1.compare(buf2, 5, 6, 5));
}
]} />
#### Since
## Since
v0.11.13
@@ -56,7 +56,7 @@ console.log(buf.toString());
// Prints: efghijghijklmnopqrstuvwxyz
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -97,7 +97,7 @@ console.log(buf.toString());
}
]} />
#### Returns
## Returns
`number`
@@ -113,6 +113,6 @@ console.log(buf.toString());
}
]} />
#### Since
## Since
v0.1.90
@@ -13,7 +13,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Returns the this object after copying a section of the array identified by start and end
to the same array starting at position target
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -45,7 +45,7 @@ to the same array starting at position target
}
]} />
#### Returns
## Returns
[Buffer](../../variables/Buffer-1.mdx)
@@ -61,6 +61,6 @@ to the same array starting at position target
}
]} />
#### Inherited from
### Inherited from
Uint8Array.copyWithin
@@ -32,7 +32,7 @@ for (const pair of buf.entries()) {
// [5, 114]
```
#### Returns
## Returns
[IterableIterator](../../interfaces/IterableIterator.mdx)&#60;[number, number]&#62;
@@ -67,10 +67,10 @@ for (const pair of buf.entries()) {
}
]} />
#### Since
## Since
v1.1.0
#### Overrides
### Overrides
Uint8Array.entries
@@ -25,7 +25,7 @@ console.log(buf1.equals(buf3));
// Prints: false
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -39,7 +39,7 @@ console.log(buf1.equals(buf3));
}
]} />
#### Returns
## Returns
`boolean`
@@ -55,6 +55,6 @@ console.log(buf1.equals(buf3));
}
]} />
#### Since
## Since
v0.11.13
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Determines whether all the members of an array satisfy the specified test.
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -35,7 +35,7 @@ Determines whether all the members of an array satisfy the specified test.
}
]} />
#### Returns
## Returns
`boolean`
@@ -51,6 +51,6 @@ Determines whether all the members of an array satisfy the specified test.
}
]} />
#### Inherited from
### Inherited from
Uint8Array.every
@@ -62,7 +62,7 @@ console.log(buf.fill('zz', 'hex'));
// Throws an exception.
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -103,7 +103,7 @@ console.log(buf.fill('zz', 'hex'));
}
]} />
#### Returns
## Returns
[Buffer](../../variables/Buffer-1.mdx)
@@ -119,10 +119,10 @@ console.log(buf.fill('zz', 'hex'));
}
]} />
#### Since
## Since
v0.5.0
#### Overrides
### Overrides
Uint8Array.fill
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Returns the elements of an array that meet the condition specified in a callback function.
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -35,7 +35,7 @@ Returns the elements of an array that meet the condition specified in a callback
}
]} />
#### Returns
## Returns
Uint8Array
@@ -51,6 +51,6 @@ Uint8Array
}
]} />
#### Inherited from
### Inherited from
Uint8Array.filter
@@ -13,7 +13,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Returns the value of the first element in the array where predicate is true, and undefined
otherwise.
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -36,7 +36,7 @@ otherwise.
}
]} />
#### Returns
## Returns
`undefined` \| `number`
@@ -52,6 +52,6 @@ otherwise.
}
]} />
#### Inherited from
### Inherited from
Uint8Array.find
@@ -13,7 +13,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Returns the index of the first element in the array where predicate is true, and -1
otherwise.
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -36,7 +36,7 @@ otherwise.
}
]} />
#### Returns
## Returns
`number`
@@ -52,6 +52,6 @@ otherwise.
}
]} />
#### Inherited from
### Inherited from
Uint8Array.findIndex
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Performs the specified action for each element in an array.
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -35,7 +35,7 @@ Performs the specified action for each element in an array.
}
]} />
#### Returns
## Returns
`void`
@@ -51,6 +51,6 @@ Performs the specified action for each element in an array.
}
]} />
#### Inherited from
### Inherited from
Uint8Array.forEach
@@ -33,7 +33,7 @@ console.log(buf.includes('this', 4));
// Prints: false
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -65,7 +65,7 @@ console.log(buf.includes('this', 4));
}
]} />
#### Returns
## Returns
`boolean`
@@ -81,10 +81,10 @@ console.log(buf.includes('this', 4));
}
]} />
#### Since
## Since
v5.3.0
#### Overrides
### Overrides
Uint8Array.includes
@@ -72,7 +72,7 @@ console.log(b.indexOf('b', []));
If `value` is an empty string or empty `Buffer` and `byteOffset` is less
than `buf.length`, `byteOffset` will be returned. If `value` is empty and`byteOffset` is at least `buf.length`, `buf.length` will be returned.
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -104,7 +104,7 @@ than `buf.length`, `byteOffset` will be returned. If `value` is empty and`byteOf
}
]} />
#### Returns
## Returns
`number`
@@ -120,10 +120,10 @@ than `buf.length`, `byteOffset` will be returned. If `value` is empty and`byteOf
}
]} />
#### Since
## Since
v1.5.0
#### Overrides
### Overrides
Uint8Array.indexOf
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Adds all the elements of an array separated by the specified separator string.
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -26,7 +26,7 @@ Adds all the elements of an array separated by the specified separator string.
}
]} />
#### Returns
## Returns
`string`
@@ -42,6 +42,6 @@ Adds all the elements of an array separated by the specified separator string.
}
]} />
#### Inherited from
### Inherited from
Uint8Array.join
@@ -29,7 +29,7 @@ for (const key of buf.keys()) {
// 5
```
#### Returns
## Returns
[IterableIterator](../../interfaces/IterableIterator.mdx)&#60;number&#62;
@@ -55,10 +55,10 @@ for (const key of buf.keys()) {
}
]} />
#### Since
## Since
v1.1.0
#### Overrides
### Overrides
Uint8Array.keys
@@ -71,7 +71,7 @@ console.log(b.lastIndexOf('b', []));
If `value` is an empty string or empty `Buffer`, `byteOffset` will be returned.
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -103,7 +103,7 @@ If `value` is an empty string or empty `Buffer`, `byteOffset` will be returned.
}
]} />
#### Returns
## Returns
`number`
@@ -119,10 +119,10 @@ If `value` is an empty string or empty `Buffer`, `byteOffset` will be returned.
}
]} />
#### Since
## Since
v6.0.0
#### Overrides
### Overrides
Uint8Array.lastIndexOf
@@ -13,7 +13,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Calls a defined callback function on each element of an array, and returns an array that
contains the results.
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -36,7 +36,7 @@ contains the results.
}
]} />
#### Returns
## Returns
Uint8Array
@@ -52,6 +52,6 @@ Uint8Array
}
]} />
#### Inherited from
### Inherited from
Uint8Array.map
@@ -15,7 +15,7 @@ Reads a signed, big-endian 64-bit integer from `buf` at the specified `offset`.
Integers read from a `Buffer` are interpreted as two's complement signed
values.
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -29,7 +29,7 @@ values.
}
]} />
#### Returns
## Returns
`bigint`
@@ -45,6 +45,6 @@ values.
}
]} />
#### Since
## Since
v12.0.0, v10.20.0
@@ -15,7 +15,7 @@ Reads a signed, little-endian 64-bit integer from `buf` at the specified`offset`
Integers read from a `Buffer` are interpreted as two's complement signed
values.
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -29,7 +29,7 @@ values.
}
]} />
#### Returns
## Returns
`bigint`
@@ -45,6 +45,6 @@ values.
}
]} />
#### Since
## Since
v12.0.0, v10.20.0
@@ -23,7 +23,7 @@ console.log(buf.readBigUInt64BE(0));
// Prints: 4294967295n
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -37,7 +37,7 @@ console.log(buf.readBigUInt64BE(0));
}
]} />
#### Returns
## Returns
`bigint`
@@ -53,6 +53,6 @@ console.log(buf.readBigUInt64BE(0));
}
]} />
#### Since
## Since
v12.0.0, v10.20.0
@@ -23,7 +23,7 @@ console.log(buf.readBigUInt64LE(0));
// Prints: 18446744069414584320n
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -37,7 +37,7 @@ console.log(buf.readBigUInt64LE(0));
}
]} />
#### Returns
## Returns
`bigint`
@@ -53,6 +53,6 @@ console.log(buf.readBigUInt64LE(0));
}
]} />
#### Since
## Since
v12.0.0, v10.20.0
@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
`**readBigUint64BE**(offset?): bigint`
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -24,7 +24,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Returns
## Returns
`bigint`
@@ -40,10 +40,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Alias
## Alias
Buffer.readBigUInt64BE
#### Since
## Since
v14.10.0, v12.19.0
@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
`**readBigUint64LE**(offset?): bigint`
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -24,7 +24,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Returns
## Returns
`bigint`
@@ -40,10 +40,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Alias
## Alias
Buffer.readBigUInt64LE
#### Since
## Since
v14.10.0, v12.19.0
@@ -21,7 +21,7 @@ console.log(buf.readDoubleBE(0));
// Prints: 8.20788039913184e-304
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -35,7 +35,7 @@ console.log(buf.readDoubleBE(0));
}
]} />
#### Returns
## Returns
`number`
@@ -51,6 +51,6 @@ console.log(buf.readDoubleBE(0));
}
]} />
#### Since
## Since
v0.11.15
@@ -23,7 +23,7 @@ console.log(buf.readDoubleLE(1));
// Throws ERR_OUT_OF_RANGE.
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -37,7 +37,7 @@ console.log(buf.readDoubleLE(1));
}
]} />
#### Returns
## Returns
`number`
@@ -53,6 +53,6 @@ console.log(buf.readDoubleLE(1));
}
]} />
#### Since
## Since
v0.11.15
@@ -21,7 +21,7 @@ console.log(buf.readFloatBE(0));
// Prints: 2.387939260590663e-38
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -35,7 +35,7 @@ console.log(buf.readFloatBE(0));
}
]} />
#### Returns
## Returns
`number`
@@ -51,6 +51,6 @@ console.log(buf.readFloatBE(0));
}
]} />
#### Since
## Since
v0.11.15
@@ -23,7 +23,7 @@ console.log(buf.readFloatLE(1));
// Throws ERR_OUT_OF_RANGE.
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -37,7 +37,7 @@ console.log(buf.readFloatLE(1));
}
]} />
#### Returns
## Returns
`number`
@@ -53,6 +53,6 @@ console.log(buf.readFloatLE(1));
}
]} />
#### Since
## Since
v0.11.15
@@ -23,7 +23,7 @@ console.log(buf.readInt16BE(0));
// Prints: 5
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -37,7 +37,7 @@ console.log(buf.readInt16BE(0));
}
]} />
#### Returns
## Returns
`number`
@@ -53,6 +53,6 @@ console.log(buf.readInt16BE(0));
}
]} />
#### Since
## Since
v0.5.5
@@ -25,7 +25,7 @@ console.log(buf.readInt16LE(1));
// Throws ERR_OUT_OF_RANGE.
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -39,7 +39,7 @@ console.log(buf.readInt16LE(1));
}
]} />
#### Returns
## Returns
`number`
@@ -55,6 +55,6 @@ console.log(buf.readInt16LE(1));
}
]} />
#### Since
## Since
v0.5.5
@@ -23,7 +23,7 @@ console.log(buf.readInt32BE(0));
// Prints: 5
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -37,7 +37,7 @@ console.log(buf.readInt32BE(0));
}
]} />
#### Returns
## Returns
`number`
@@ -53,6 +53,6 @@ console.log(buf.readInt32BE(0));
}
]} />
#### Since
## Since
v0.5.5
@@ -25,7 +25,7 @@ console.log(buf.readInt32LE(1));
// Throws ERR_OUT_OF_RANGE.
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -39,7 +39,7 @@ console.log(buf.readInt32LE(1));
}
]} />
#### Returns
## Returns
`number`
@@ -55,6 +55,6 @@ console.log(buf.readInt32LE(1));
}
]} />
#### Since
## Since
v0.5.5
@@ -27,7 +27,7 @@ console.log(buf.readInt8(2));
// Throws ERR_OUT_OF_RANGE.
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -41,7 +41,7 @@ console.log(buf.readInt8(2));
}
]} />
#### Returns
## Returns
`number`
@@ -57,6 +57,6 @@ console.log(buf.readInt8(2));
}
]} />
#### Since
## Since
v0.5.0
@@ -26,7 +26,7 @@ console.log(buf.readIntBE(1, 0).toString(16));
// Throws ERR_OUT_OF_RANGE.
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -49,7 +49,7 @@ console.log(buf.readIntBE(1, 0).toString(16));
}
]} />
#### Returns
## Returns
`number`
@@ -65,6 +65,6 @@ console.log(buf.readIntBE(1, 0).toString(16));
}
]} />
#### Since
## Since
v0.11.15
@@ -22,7 +22,7 @@ console.log(buf.readIntLE(0, 6).toString(16));
// Prints: -546f87a9cbee
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -45,7 +45,7 @@ console.log(buf.readIntLE(0, 6).toString(16));
}
]} />
#### Returns
## Returns
`number`
@@ -61,6 +61,6 @@ console.log(buf.readIntLE(0, 6).toString(16));
}
]} />
#### Since
## Since
v0.11.15
@@ -25,7 +25,7 @@ console.log(buf.readUInt16BE(1).toString(16));
// Prints: 3456
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -39,7 +39,7 @@ console.log(buf.readUInt16BE(1).toString(16));
}
]} />
#### Returns
## Returns
`number`
@@ -55,6 +55,6 @@ console.log(buf.readUInt16BE(1).toString(16));
}
]} />
#### Since
## Since
v0.5.5
@@ -27,7 +27,7 @@ console.log(buf.readUInt16LE(2).toString(16));
// Throws ERR_OUT_OF_RANGE.
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -41,7 +41,7 @@ console.log(buf.readUInt16LE(2).toString(16));
}
]} />
#### Returns
## Returns
`number`
@@ -57,6 +57,6 @@ console.log(buf.readUInt16LE(2).toString(16));
}
]} />
#### Since
## Since
v0.5.5
@@ -23,7 +23,7 @@ console.log(buf.readUInt32BE(0).toString(16));
// Prints: 12345678
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -37,7 +37,7 @@ console.log(buf.readUInt32BE(0).toString(16));
}
]} />
#### Returns
## Returns
`number`
@@ -53,6 +53,6 @@ console.log(buf.readUInt32BE(0).toString(16));
}
]} />
#### Since
## Since
v0.5.5
@@ -25,7 +25,7 @@ console.log(buf.readUInt32LE(1).toString(16));
// Throws ERR_OUT_OF_RANGE.
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -39,7 +39,7 @@ console.log(buf.readUInt32LE(1).toString(16));
}
]} />
#### Returns
## Returns
`number`
@@ -55,6 +55,6 @@ console.log(buf.readUInt32LE(1).toString(16));
}
]} />
#### Since
## Since
v0.5.5
@@ -27,7 +27,7 @@ console.log(buf.readUInt8(2));
// Throws ERR_OUT_OF_RANGE.
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -41,7 +41,7 @@ console.log(buf.readUInt8(2));
}
]} />
#### Returns
## Returns
`number`
@@ -57,6 +57,6 @@ console.log(buf.readUInt8(2));
}
]} />
#### Since
## Since
v0.5.0
@@ -26,7 +26,7 @@ console.log(buf.readUIntBE(1, 6).toString(16));
// Throws ERR_OUT_OF_RANGE.
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -49,7 +49,7 @@ console.log(buf.readUIntBE(1, 6).toString(16));
}
]} />
#### Returns
## Returns
`number`
@@ -65,6 +65,6 @@ console.log(buf.readUIntBE(1, 6).toString(16));
}
]} />
#### Since
## Since
v0.11.15
@@ -24,7 +24,7 @@ console.log(buf.readUIntLE(0, 6).toString(16));
// Prints: ab9078563412
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -47,7 +47,7 @@ console.log(buf.readUIntLE(0, 6).toString(16));
}
]} />
#### Returns
## Returns
`number`
@@ -63,6 +63,6 @@ console.log(buf.readUIntLE(0, 6).toString(16));
}
]} />
#### Since
## Since
v0.11.15
@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
`**readUint16BE**(offset?): number`
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -24,7 +24,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Returns
## Returns
`number`
@@ -40,10 +40,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Alias
## Alias
Buffer.readUInt16BE
#### Since
## Since
v14.9.0, v12.19.0
@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
`**readUint16LE**(offset?): number`
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -24,7 +24,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Returns
## Returns
`number`
@@ -40,10 +40,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Alias
## Alias
Buffer.readUInt16LE
#### Since
## Since
v14.9.0, v12.19.0
@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
`**readUint32BE**(offset?): number`
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -24,7 +24,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Returns
## Returns
`number`
@@ -40,10 +40,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Alias
## Alias
Buffer.readUInt32BE
#### Since
## Since
v14.9.0, v12.19.0
@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
`**readUint32LE**(offset?): number`
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -24,7 +24,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Returns
## Returns
`number`
@@ -40,10 +40,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Alias
## Alias
Buffer.readUInt32LE
#### Since
## Since
v14.9.0, v12.19.0
@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
`**readUint8**(offset?): number`
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -24,7 +24,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Returns
## Returns
`number`
@@ -40,10 +40,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Alias
## Alias
Buffer.readUInt8
#### Since
## Since
v14.9.0, v12.19.0
@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
`**readUintBE**(offset, byteLength): number`
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -33,7 +33,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Returns
## Returns
`number`
@@ -49,10 +49,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Alias
## Alias
Buffer.readUIntBE
#### Since
## Since
v14.9.0, v12.19.0
@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
`**readUintLE**(offset, byteLength): number`
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -33,7 +33,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Returns
## Returns
`number`
@@ -49,10 +49,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Alias
## Alias
Buffer.readUIntLE
#### Since
## Since
v14.9.0, v12.19.0
@@ -14,7 +14,7 @@ Calls the specified callback function for all the elements in an array. The retu
the callback function is the accumulated result, and is provided as an argument in the next
call to the callback function.
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -28,7 +28,7 @@ call to the callback function.
}
]} />
#### Returns
## Returns
`number`
@@ -44,13 +44,13 @@ call to the callback function.
}
]} />
#### Inherited from
### Inherited from
Uint8Array.reduce
`**reduce**(callbackfn, initialValue): number`
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -73,7 +73,7 @@ Uint8Array.reduce
}
]} />
#### Returns
## Returns
`number`
@@ -89,7 +89,7 @@ Uint8Array.reduce
}
]} />
#### Inherited from
### Inherited from
Uint8Array.reduce
@@ -99,7 +99,7 @@ Calls the specified callback function for all the elements in an array. The retu
the callback function is the accumulated result, and is provided as an argument in the next
call to the callback function.
#### Type Parameters
## Type Parameters
<ParameterTypes parameters={[
{
@@ -113,7 +113,7 @@ call to the callback function.
}
]} />
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -136,7 +136,7 @@ call to the callback function.
}
]} />
#### Returns
## Returns
`U`
@@ -152,6 +152,6 @@ call to the callback function.
}
]} />
#### Inherited from
### Inherited from
Uint8Array.reduce
@@ -14,7 +14,7 @@ Calls the specified callback function for all the elements in an array, in desce
The return value of the callback function is the accumulated result, and is provided as an
argument in the next call to the callback function.
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -28,7 +28,7 @@ argument in the next call to the callback function.
}
]} />
#### Returns
## Returns
`number`
@@ -44,13 +44,13 @@ argument in the next call to the callback function.
}
]} />
#### Inherited from
### Inherited from
Uint8Array.reduceRight
`**reduceRight**(callbackfn, initialValue): number`
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -73,7 +73,7 @@ Uint8Array.reduceRight
}
]} />
#### Returns
## Returns
`number`
@@ -89,7 +89,7 @@ Uint8Array.reduceRight
}
]} />
#### Inherited from
### Inherited from
Uint8Array.reduceRight
@@ -99,7 +99,7 @@ Calls the specified callback function for all the elements in an array, in desce
The return value of the callback function is the accumulated result, and is provided as an
argument in the next call to the callback function.
#### Type Parameters
## Type Parameters
<ParameterTypes parameters={[
{
@@ -113,7 +113,7 @@ argument in the next call to the callback function.
}
]} />
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -136,7 +136,7 @@ argument in the next call to the callback function.
}
]} />
#### Returns
## Returns
`U`
@@ -152,6 +152,6 @@ argument in the next call to the callback function.
}
]} />
#### Inherited from
### Inherited from
Uint8Array.reduceRight
@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
`**reverse**(): [Buffer](../../variables/Buffer-1.mdx)`
#### Returns
## Returns
[Buffer](../../variables/Buffer-1.mdx)
@@ -26,6 +26,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Overrides
### Overrides
Uint8Array.reverse
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Sets a value or an array of values.
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -45,7 +45,7 @@ Sets a value or an array of values.
}
]} />
#### Returns
## Returns
`void`
@@ -61,6 +61,6 @@ Sets a value or an array of values.
}
]} />
#### Inherited from
### Inherited from
Uint8Array.set
@@ -38,7 +38,7 @@ console.log(buf.toString());
// Also prints: cuffer (!)
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -61,7 +61,7 @@ console.log(buf.toString());
}
]} />
#### Returns
## Returns
[Buffer](../../variables/Buffer-1.mdx)
@@ -77,14 +77,14 @@ console.log(buf.toString());
}
]} />
#### Since
## Since
v0.3.0
#### Deprecated
## Deprecated
Use `subarray` instead.
#### Overrides
### Overrides
Uint8Array.slice
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Determines whether the specified callback function returns true for any element of an array.
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -35,7 +35,7 @@ Determines whether the specified callback function returns true for any element
}
]} />
#### Returns
## Returns
`boolean`
@@ -51,6 +51,6 @@ Determines whether the specified callback function returns true for any element
}
]} />
#### Inherited from
### Inherited from
Uint8Array.some
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Sorts an array.
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -26,7 +26,7 @@ Sorts an array.
}
]} />
#### Returns
## Returns
[Buffer](../../variables/Buffer-1.mdx)
@@ -42,6 +42,6 @@ Sorts an array.
}
]} />
#### Inherited from
### Inherited from
Uint8Array.sort
@@ -65,7 +65,7 @@ console.log(buf.subarray(-5, -2).toString());
// (Equivalent to buf.subarray(1, 4).)
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -88,7 +88,7 @@ console.log(buf.subarray(-5, -2).toString());
}
]} />
#### Returns
## Returns
[Buffer](../../variables/Buffer-1.mdx)
@@ -104,10 +104,10 @@ console.log(buf.subarray(-5, -2).toString());
}
]} />
#### Since
## Since
v3.0.0
#### Overrides
### Overrides
Uint8Array.subarray
@@ -42,7 +42,7 @@ const buf = Buffer.from('This is little-endian UTF-16', 'utf16le');
buf.swap16(); // Convert to big-endian UTF-16 text.
```
#### Returns
## Returns
[Buffer](../../variables/Buffer-1.mdx)
@@ -58,6 +58,6 @@ buf.swap16(); // Convert to big-endian UTF-16 text.
}
]} />
#### Since
## Since
v5.10.0
@@ -32,7 +32,7 @@ buf2.swap32();
// Throws ERR_INVALID_BUFFER_SIZE.
```
#### Returns
## Returns
[Buffer](../../variables/Buffer-1.mdx)
@@ -48,6 +48,6 @@ buf2.swap32();
}
]} />
#### Since
## Since
v5.10.0
@@ -32,7 +32,7 @@ buf2.swap64();
// Throws ERR_INVALID_BUFFER_SIZE.
```
#### Returns
## Returns
[Buffer](../../variables/Buffer-1.mdx)
@@ -48,6 +48,6 @@ buf2.swap64();
}
]} />
#### Since
## Since
v6.3.0
@@ -35,7 +35,7 @@ console.log(copy);
// Prints: <Buffer 01 02 03 04 05>
```
#### Returns
## Returns
`object`
@@ -72,6 +72,6 @@ console.log(copy);
}
]} />
#### Since
## Since
v0.9.2
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Converts a number to a string by using the current locale.
#### Returns
## Returns
`string`
@@ -28,6 +28,6 @@ Converts a number to a string by using the current locale.
}
]} />
#### Inherited from
### Inherited from
Uint8Array.toLocaleString
@@ -43,7 +43,7 @@ console.log(buf2.toString(undefined, 0, 3));
// Prints: té
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -75,7 +75,7 @@ console.log(buf2.toString(undefined, 0, 3));
}
]} />
#### Returns
## Returns
`string`
@@ -91,10 +91,10 @@ console.log(buf2.toString(undefined, 0, 3));
}
]} />
#### Since
## Since
v0.1.90
#### Overrides
### Overrides
Uint8Array.toString
@@ -12,7 +12,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
Returns the primitive value of the specified object.
#### Returns
## Returns
Uint8Array
@@ -28,6 +28,6 @@ Uint8Array
}
]} />
#### Inherited from
### Inherited from
Uint8Array.valueOf
@@ -41,7 +41,7 @@ for (const value of buf) {
// 114
```
#### Returns
## Returns
[IterableIterator](../../interfaces/IterableIterator.mdx)&#60;number&#62;
@@ -67,10 +67,10 @@ for (const value of buf) {
}
]} />
#### Since
## Since
v1.1.0
#### Overrides
### Overrides
Uint8Array.values
@@ -32,7 +32,7 @@ console.log(`${length} bytes: ${buffer.toString('utf8', 8, 10)}`);
// Prints: 2 bytes : ab
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -55,7 +55,7 @@ console.log(`${length} bytes: ${buffer.toString('utf8', 8, 10)}`);
}
]} />
#### Returns
## Returns
`number`
@@ -71,13 +71,13 @@ console.log(`${length} bytes: ${buffer.toString('utf8', 8, 10)}`);
}
]} />
#### Since
## Since
v0.1.90
`**write**(string, offset, encoding?): number`
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -109,7 +109,7 @@ v0.1.90
}
]} />
#### Returns
## Returns
`number`
@@ -127,7 +127,7 @@ v0.1.90
`**write**(string, offset, length, encoding?): number`
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -168,7 +168,7 @@ v0.1.90
}
]} />
#### Returns
## Returns
`number`
@@ -25,7 +25,7 @@ console.log(buf);
// Prints: <Buffer 01 02 03 04 05 06 07 08>
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -48,7 +48,7 @@ console.log(buf);
}
]} />
#### Returns
## Returns
`number`
@@ -64,6 +64,6 @@ console.log(buf);
}
]} />
#### Since
## Since
v12.0.0, v10.20.0
@@ -25,7 +25,7 @@ console.log(buf);
// Prints: <Buffer 08 07 06 05 04 03 02 01>
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -48,7 +48,7 @@ console.log(buf);
}
]} />
#### Returns
## Returns
`number`
@@ -64,6 +64,6 @@ console.log(buf);
}
]} />
#### Since
## Since
v12.0.0, v10.20.0
@@ -25,7 +25,7 @@ console.log(buf);
// Prints: <Buffer de ca fa fe ca ce fa de>
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -48,7 +48,7 @@ console.log(buf);
}
]} />
#### Returns
## Returns
`number`
@@ -64,6 +64,6 @@ console.log(buf);
}
]} />
#### Since
## Since
v12.0.0, v10.20.0
@@ -25,7 +25,7 @@ console.log(buf);
This function is also available under the `writeBigUint64LE` alias.
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -48,7 +48,7 @@ This function is also available under the `writeBigUint64LE` alias.
}
]} />
#### Returns
## Returns
`number`
@@ -64,6 +64,6 @@ This function is also available under the `writeBigUint64LE` alias.
}
]} />
#### Since
## Since
v12.0.0, v10.20.0
@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
`**writeBigUint64BE**(value, offset?): number`
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -33,7 +33,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Returns
## Returns
`number`
@@ -49,10 +49,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Alias
## Alias
Buffer.writeBigUInt64BE
#### Since
## Since
v14.10.0, v12.19.0
@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
`**writeBigUint64LE**(value, offset?): number`
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -33,7 +33,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Returns
## Returns
`number`
@@ -49,10 +49,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Alias
## Alias
Buffer.writeBigUInt64LE
#### Since
## Since
v14.10.0, v12.19.0
@@ -24,7 +24,7 @@ console.log(buf);
// Prints: <Buffer 40 5e dd 2f 1a 9f be 77>
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -47,7 +47,7 @@ console.log(buf);
}
]} />
#### Returns
## Returns
`number`
@@ -63,6 +63,6 @@ console.log(buf);
}
]} />
#### Since
## Since
v0.11.15
@@ -24,7 +24,7 @@ console.log(buf);
// Prints: <Buffer 77 be 9f 1a 2f dd 5e 40>
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -47,7 +47,7 @@ console.log(buf);
}
]} />
#### Returns
## Returns
`number`
@@ -63,6 +63,6 @@ console.log(buf);
}
]} />
#### Since
## Since
v0.11.15
@@ -24,7 +24,7 @@ console.log(buf);
// Prints: <Buffer 4f 4a fe bb>
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -47,7 +47,7 @@ console.log(buf);
}
]} />
#### Returns
## Returns
`number`
@@ -63,6 +63,6 @@ console.log(buf);
}
]} />
#### Since
## Since
v0.11.15
@@ -24,7 +24,7 @@ console.log(buf);
// Prints: <Buffer bb fe 4a 4f>
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -47,7 +47,7 @@ console.log(buf);
}
]} />
#### Returns
## Returns
`number`
@@ -63,6 +63,6 @@ console.log(buf);
}
]} />
#### Since
## Since
v0.11.15
@@ -26,7 +26,7 @@ console.log(buf);
// Prints: <Buffer 01 02>
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -49,7 +49,7 @@ console.log(buf);
}
]} />
#### Returns
## Returns
`number`
@@ -65,6 +65,6 @@ console.log(buf);
}
]} />
#### Since
## Since
v0.5.5
@@ -26,7 +26,7 @@ console.log(buf);
// Prints: <Buffer 04 03>
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -49,7 +49,7 @@ console.log(buf);
}
]} />
#### Returns
## Returns
`number`
@@ -65,6 +65,6 @@ console.log(buf);
}
]} />
#### Since
## Since
v0.5.5
@@ -26,7 +26,7 @@ console.log(buf);
// Prints: <Buffer 01 02 03 04>
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -49,7 +49,7 @@ console.log(buf);
}
]} />
#### Returns
## Returns
`number`
@@ -65,6 +65,6 @@ console.log(buf);
}
]} />
#### Since
## Since
v0.5.5
@@ -26,7 +26,7 @@ console.log(buf);
// Prints: <Buffer 08 07 06 05>
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -49,7 +49,7 @@ console.log(buf);
}
]} />
#### Returns
## Returns
`number`
@@ -65,6 +65,6 @@ console.log(buf);
}
]} />
#### Since
## Since
v0.5.5
@@ -28,7 +28,7 @@ console.log(buf);
// Prints: <Buffer 02 fe>
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -51,7 +51,7 @@ console.log(buf);
}
]} />
#### Returns
## Returns
`number`
@@ -67,6 +67,6 @@ console.log(buf);
}
]} />
#### Since
## Since
v0.5.0
@@ -24,7 +24,7 @@ console.log(buf);
// Prints: <Buffer 12 34 56 78 90 ab>
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -56,7 +56,7 @@ console.log(buf);
}
]} />
#### Returns
## Returns
`number`
@@ -72,6 +72,6 @@ console.log(buf);
}
]} />
#### Since
## Since
v0.11.15
@@ -24,7 +24,7 @@ console.log(buf);
// Prints: <Buffer ab 90 78 56 34 12>
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -56,7 +56,7 @@ console.log(buf);
}
]} />
#### Returns
## Returns
`number`
@@ -72,6 +72,6 @@ console.log(buf);
}
]} />
#### Since
## Since
v0.11.15
@@ -27,7 +27,7 @@ console.log(buf);
// Prints: <Buffer de ad be ef>
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -50,7 +50,7 @@ console.log(buf);
}
]} />
#### Returns
## Returns
`number`
@@ -66,6 +66,6 @@ console.log(buf);
}
]} />
#### Since
## Since
v0.5.5
@@ -27,7 +27,7 @@ console.log(buf);
// Prints: <Buffer ad de ef be>
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -50,7 +50,7 @@ console.log(buf);
}
]} />
#### Returns
## Returns
`number`
@@ -66,6 +66,6 @@ console.log(buf);
}
]} />
#### Since
## Since
v0.5.5
@@ -26,7 +26,7 @@ console.log(buf);
// Prints: <Buffer fe ed fa ce>
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -49,7 +49,7 @@ console.log(buf);
}
]} />
#### Returns
## Returns
`number`
@@ -65,6 +65,6 @@ console.log(buf);
}
]} />
#### Since
## Since
v0.5.5
@@ -26,7 +26,7 @@ console.log(buf);
// Prints: <Buffer ce fa ed fe>
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -49,7 +49,7 @@ console.log(buf);
}
]} />
#### Returns
## Returns
`number`
@@ -65,6 +65,6 @@ console.log(buf);
}
]} />
#### Since
## Since
v0.5.5
@@ -30,7 +30,7 @@ console.log(buf);
// Prints: <Buffer 03 04 23 42>
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -53,7 +53,7 @@ console.log(buf);
}
]} />
#### Returns
## Returns
`number`
@@ -69,6 +69,6 @@ console.log(buf);
}
]} />
#### Since
## Since
v0.5.0
@@ -26,7 +26,7 @@ console.log(buf);
// Prints: <Buffer 12 34 56 78 90 ab>
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -58,7 +58,7 @@ console.log(buf);
}
]} />
#### Returns
## Returns
`number`
@@ -74,6 +74,6 @@ console.log(buf);
}
]} />
#### Since
## Since
v0.5.5
@@ -26,7 +26,7 @@ console.log(buf);
// Prints: <Buffer ab 90 78 56 34 12>
```
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -58,7 +58,7 @@ console.log(buf);
}
]} />
#### Returns
## Returns
`number`
@@ -74,6 +74,6 @@ console.log(buf);
}
]} />
#### Since
## Since
v0.5.5
@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
`**writeUint16BE**(value, offset?): number`
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -33,7 +33,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Returns
## Returns
`number`
@@ -49,10 +49,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Alias
## Alias
Buffer.writeUInt16BE
#### Since
## Since
v14.9.0, v12.19.0
@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
`**writeUint16LE**(value, offset?): number`
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -33,7 +33,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Returns
## Returns
`number`
@@ -49,10 +49,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Alias
## Alias
Buffer.writeUInt16LE
#### Since
## Since
v14.9.0, v12.19.0
@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
`**writeUint32BE**(value, offset?): number`
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -33,7 +33,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Returns
## Returns
`number`
@@ -49,10 +49,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Alias
## Alias
Buffer.writeUInt32BE
#### Since
## Since
v14.9.0, v12.19.0
@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
`**writeUint32LE**(value, offset?): number`
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -33,7 +33,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Returns
## Returns
`number`
@@ -49,10 +49,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Alias
## Alias
Buffer.writeUInt32LE
#### Since
## Since
v14.9.0, v12.19.0
@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
`**writeUint8**(value, offset?): number`
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -33,7 +33,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Returns
## Returns
`number`
@@ -49,10 +49,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Alias
## Alias
Buffer.writeUInt8
#### Since
## Since
v14.9.0, v12.19.0
@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
`**writeUintBE**(value, offset, byteLength): number`
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -42,7 +42,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Returns
## Returns
`number`
@@ -58,10 +58,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Alias
## Alias
Buffer.writeUIntBE
#### Since
## Since
v14.9.0, v12.19.0
@@ -10,7 +10,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
`**writeUintLE**(value, offset, byteLength): number`
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -42,7 +42,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Returns
## Returns
`number`
@@ -58,10 +58,10 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
}
]} />
#### Alias
## Alias
Buffer.writeUIntLE
#### Since
## Since
v14.9.0, v12.19.0
@@ -52,7 +52,7 @@ data that might not have been allocated for `Buffer`s.
A `TypeError` will be thrown if `size` is not a number.
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -84,7 +84,7 @@ A `TypeError` will be thrown if `size` is not a number.
}
]} />
#### Returns
## Returns
[Buffer](../../variables/Buffer-1.mdx)
@@ -100,6 +100,6 @@ A `TypeError` will be thrown if `size` is not a number.
}
]} />
#### Since
## Since
v5.10.0
@@ -42,7 +42,7 @@ than or equal to half `Buffer.poolSize`. The
difference is subtle but can be important when an application requires the
additional performance that `Buffer.allocUnsafe()` provides.
#### Parameters
## Parameters
<ParameterTypes parameters={[
{
@@ -56,7 +56,7 @@ additional performance that `Buffer.allocUnsafe()` provides.
}
]} />
#### Returns
## Returns
[Buffer](../../variables/Buffer-1.mdx)
@@ -72,6 +72,6 @@ additional performance that `Buffer.allocUnsafe()` provides.
}
]} />
#### Since
## Since
v5.10.0
Loaded 100 of 1479 files, more files were not shown because too many files have changed in this diff. Show more