Interface Buffer
Hierarchy
-
NodeBuffer
- Buffer
Indexable
Raw data is stored in instances of the Buffer class. A Buffer is similar to an array of integers but corresponds to a raw memory allocation outside the V8 heap. A Buffer cannot be resized. Valid string encodings: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'binary'(deprecated)|'hex'
Index
Properties
Methods
- __@iterator
- compare
- copy
- copy
Within - entries
- equals
- every
- fill
- filter
- find
- find
Index - for
Each - includes
- index
Of - join
- keys
- last
Index Of - map
- read
DoubleBE - read
DoubleLE - read
FloatBE - read
FloatLE - read
Int16BE - read
Int16LE - read
Int32BE - read
Int32LE - read
Int8 - read
IntBE - read
IntLE - readUInt16BE
- readUInt16LE
- readUInt32BE
- readUInt32LE
- readUInt8
- readUIntBE
- readUIntLE
- reduce
- reduce
Right - reverse
- set
- slice
- some
- sort
- subarray
- swap16
- swap32
- swap64
- toJSON
- to
Locale String - to
String - values
- write
- write
DoubleBE - write
DoubleLE - write
FloatBE - write
FloatLE - write
Int16BE - write
Int16LE - write
Int32BE - write
Int32LE - write
Int8 - write
IntBE - write
IntLE - writeUInt16BE
- writeUInt16LE
- writeUInt32BE
- writeUInt32LE
- writeUInt8
- writeUIntBE
- writeUIntLE
Properties
BYTES_PER_ELEMENT
The size in bytes of each element in the array.
__@toStringTag
buffer
The ArrayBuffer instance referenced by the array.
byteLength
The length in bytes of the array.
byteOffset
The offset in bytes of the array.
length
The length of the array.
Methods
__@iterator
-
Returns IterableIterator<number>
compare
-
Parameters
-
otherBuffer: Buffer
-
Optional targetStart: number
-
Optional targetEnd: number
-
Optional sourceStart: number
-
Optional sourceEnd: number
Returns number
-
copy
-
Parameters
-
targetBuffer: Buffer
-
Optional targetStart: number
-
Optional sourceStart: number
-
Optional sourceEnd: number
Returns number
-
copyWithin
-
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
-
target: number
If target is negative, it is treated as length+target where length is the length of the array.
-
start: number
If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
-
Optional end: number
If not specified, length of the this object is used as its default value.
Returns this
-
entries
-
Returns IterableIterator<[number, number]>
equals
-
Parameters
-
otherBuffer: Buffer
Returns boolean
-
every
-
Determines whether all the members of an array satisfy the specified test.
Parameters
-
callbackfn: function
A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
-
-
Parameters
-
value: number
-
index: number
-
array: Uint8Array
Returns boolean
-
-
-
-
Optional thisArg: any
An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean
-
fill
-
Parameters
-
value: any
-
Optional offset: number
-
Optional end: number
Returns this
-
filter
-
Returns the elements of an array that meet the condition specified in a callback function.
Parameters
-
callbackfn: function
A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
-
-
Parameters
-
value: number
-
index: number
-
array: Uint8Array
Returns any
-
-
-
-
Optional thisArg: any
An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns Uint8Array
-
find
-
Returns the value of the first element in the array where predicate is true, and undefined otherwise.
Parameters
-
predicate: function
find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
-
-
Parameters
-
value: number
-
index: number
-
obj: Uint8Array
Returns boolean
-
-
-
-
Optional thisArg: any
If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number | undefined
-
findIndex
-
Returns the index of the first element in the array where predicate is true, and -1 otherwise.
Parameters
-
predicate: function
find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
-
-
Parameters
-
value: number
-
index: number
-
obj: Uint8Array
Returns boolean
-
-
-
-
Optional thisArg: any
If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number
-
forEach
-
Performs the specified action for each element in an array.
Parameters
-
callbackfn: function
A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
-
-
Parameters
-
value: number
-
index: number
-
array: Uint8Array
Returns void
-
-
-
-
Optional thisArg: any
An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void
-
includes
-
Parameters
-
value: string | number | Buffer
-
Optional byteOffset: number
-
Optional encoding: string
Returns boolean
-
indexOf
-
Parameters
-
value: string | number | Buffer
-
Optional byteOffset: number
-
Optional encoding: string
Returns number
-
join
-
Adds all the elements of an array separated by the specified separator string.
Parameters
-
Optional separator: string
A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string
-
keys
-
Returns IterableIterator<number>
lastIndexOf
-
Parameters
-
value: string | number | Buffer
-
Optional byteOffset: number
-
Optional encoding: string
Returns number
-
map
-
Calls a defined callback function on each element of an array, and returns an array that contains the results.
Parameters
-
callbackfn: function
A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
-
-
Parameters
-
value: number
-
index: number
-
array: Uint8Array
Returns number
-
-
-
-
Optional thisArg: any
An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns Uint8Array
-
readDoubleBE
-
Parameters
-
offset: number
-
Optional noAssert: boolean
Returns number
-
readDoubleLE
-
Parameters
-
offset: number
-
Optional noAssert: boolean
Returns number
-
readFloatBE
-
Parameters
-
offset: number
-
Optional noAssert: boolean
Returns number
-
readFloatLE
-
Parameters
-
offset: number
-
Optional noAssert: boolean
Returns number
-
readInt16BE
-
Parameters
-
offset: number
-
Optional noAssert: boolean
Returns number
-
readInt16LE
-
Parameters
-
offset: number
-
Optional noAssert: boolean
Returns number
-
readInt32BE
-
Parameters
-
offset: number
-
Optional noAssert: boolean
Returns number
-
readInt32LE
-
Parameters
-
offset: number
-
Optional noAssert: boolean
Returns number
-
readInt8
-
Parameters
-
offset: number
-
Optional noAssert: boolean
Returns number
-
readIntBE
-
Parameters
-
offset: number
-
byteLength: number
-
Optional noAssert: boolean
Returns number
-
readIntLE
-
Parameters
-
offset: number
-
byteLength: number
-
Optional noAssert: boolean
Returns number
-
readUInt16BE
-
Parameters
-
offset: number
-
Optional noAssert: boolean
Returns number
-
readUInt16LE
-
Parameters
-
offset: number
-
Optional noAssert: boolean
Returns number
-
readUInt32BE
-
Parameters
-
offset: number
-
Optional noAssert: boolean
Returns number
-
readUInt32LE
-
Parameters
-
offset: number
-
Optional noAssert: boolean
Returns number
-
readUInt8
-
Parameters
-
offset: number
-
Optional noAssert: boolean
Returns number
-
readUIntBE
-
Parameters
-
offset: number
-
byteLength: number
-
Optional noAssert: boolean
Returns number
-
readUIntLE
-
Parameters
-
offset: number
-
byteLength: number
-
Optional noAssert: boolean
Returns number
-
reduce
-
Calls the specified callback function for all the elements in an array. 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
-
callbackfn: function
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
-
-
Parameters
-
previousValue: number
-
currentValue: number
-
currentIndex: number
-
array: Uint8Array
Returns number
-
-
-
Returns number
-
-
Parameters
-
callbackfn: function
-
-
Parameters
-
previousValue: number
-
currentValue: number
-
currentIndex: number
-
array: Uint8Array
Returns number
-
-
-
-
initialValue: number
Returns number
-
-
Calls the specified callback function for all the elements in an array. 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
-
U
Parameters
-
callbackfn: function
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
-
-
Parameters
-
previousValue: U
-
currentValue: number
-
currentIndex: number
-
array: Uint8Array
Returns U
-
-
-
-
initialValue: U
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U
-
reduceRight
-
Calls the specified callback function for all the elements in an array, in descending order. 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
-
callbackfn: function
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
-
-
Parameters
-
previousValue: number
-
currentValue: number
-
currentIndex: number
-
array: Uint8Array
Returns number
-
-
-
Returns number
-
-
Parameters
-
callbackfn: function
-
-
Parameters
-
previousValue: number
-
currentValue: number
-
currentIndex: number
-
array: Uint8Array
Returns number
-
-
-
-
initialValue: number
Returns number
-
-
Calls the specified callback function for all the elements in an array, in descending order. 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
-
U
Parameters
-
callbackfn: function
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
-
-
Parameters
-
previousValue: U
-
currentValue: number
-
currentIndex: number
-
array: Uint8Array
Returns U
-
-
-
-
initialValue: U
If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U
-
reverse
-
Reverses the elements in an Array.
Returns Uint8Array
set
-
Sets a value or an array of values.
Parameters
-
array: ArrayLike<number>
A typed or untyped array of values to set.
-
Optional offset: number
The index in the current array at which the values are to be written.
Returns void
-
slice
-
Parameters
-
Optional start: number
-
Optional end: number
Returns Buffer
-
some
-
Determines whether the specified callback function returns true for any element of an array.
Parameters
-
callbackfn: function
A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
-
-
Parameters
-
value: number
-
index: number
-
array: Uint8Array
Returns boolean
-
-
-
-
Optional thisArg: any
An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean
-
sort
-
Sorts an array.
Parameters
-
Optional compareFn: function
The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
-
-
Parameters
-
a: number
-
b: number
Returns number
-
-
-
Returns this
-
subarray
-
Gets a new Uint8Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive.
Parameters
-
begin: number
The index of the beginning of the array.
-
Optional end: number
The index of the end of the array.
Returns Uint8Array
-
swap16
-
Returns Buffer
swap32
-
Returns Buffer
swap64
-
Returns Buffer
toJSON
-
Returns object
-
data: any[]
-
type: "Buffer"
-
toLocaleString
-
Converts a number to a string by using the current locale.
Returns string
toString
-
Parameters
-
Optional encoding: string
-
Optional start: number
-
Optional end: number
Returns string
-
values
-
Returns IterableIterator<number>
write
-
Parameters
-
string: string
-
Optional offset: number
-
Optional length: number
-
Optional encoding: string
Returns number
-
writeDoubleBE
-
Parameters
-
value: number
-
offset: number
-
Optional noAssert: boolean
Returns number
-
writeDoubleLE
-
Parameters
-
value: number
-
offset: number
-
Optional noAssert: boolean
Returns number
-
writeFloatBE
-
Parameters
-
value: number
-
offset: number
-
Optional noAssert: boolean
Returns number
-
writeFloatLE
-
Parameters
-
value: number
-
offset: number
-
Optional noAssert: boolean
Returns number
-
writeInt16BE
-
Parameters
-
value: number
-
offset: number
-
Optional noAssert: boolean
Returns number
-
writeInt16LE
-
Parameters
-
value: number
-
offset: number
-
Optional noAssert: boolean
Returns number
-
writeInt32BE
-
Parameters
-
value: number
-
offset: number
-
Optional noAssert: boolean
Returns number
-
writeInt32LE
-
Parameters
-
value: number
-
offset: number
-
Optional noAssert: boolean
Returns number
-
writeInt8
-
Parameters
-
value: number
-
offset: number
-
Optional noAssert: boolean
Returns number
-
writeIntBE
-
Parameters
-
value: number
-
offset: number
-
byteLength: number
-
Optional noAssert: boolean
Returns number
-
writeIntLE
-
Parameters
-
value: number
-
offset: number
-
byteLength: number
-
Optional noAssert: boolean
Returns number
-
writeUInt16BE
-
Parameters
-
value: number
-
offset: number
-
Optional noAssert: boolean
Returns number
-
writeUInt16LE
-
Parameters
-
value: number
-
offset: number
-
Optional noAssert: boolean
Returns number
-
writeUInt32BE
-
Parameters
-
value: number
-
offset: number
-
Optional noAssert: boolean
Returns number
-
writeUInt32LE
-
Parameters
-
value: number
-
offset: number
-
Optional noAssert: boolean
Returns number
-
writeUInt8
-
Parameters
-
value: number
-
offset: number
-
Optional noAssert: boolean
Returns number
-
writeUIntBE
-
Parameters
-
value: number
-
offset: number
-
byteLength: number
-
Optional noAssert: boolean
Returns number
-
writeUIntLE
-
Parameters
-
value: number
-
offset: number
-
byteLength: number
-
Optional noAssert: boolean
Returns number
-
Generated using TypeDoc
Raw data is stored in instances of the Buffer class. A Buffer is similar to an array of integers but corresponds to a raw memory allocation outside the V8 heap. A Buffer cannot be resized. Valid string encodings: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'binary'(deprecated)|'hex'