Allocates a new buffer containing the given {str}.
since v10.0.0 - Use Buffer.from(string[, encoding]) instead.
String to store in buffer.
Optional encoding: BufferEncodingencoding to use, optional. Default is 'utf8'
Allocates a new buffer of {size} octets.
since v10.0.0 - Use Buffer.alloc() instead (also see Buffer.allocUnsafe()).
count of octets to allocate.
Allocates a new buffer containing the given {array} of octets.
since v10.0.0 - Use Buffer.from(array) instead.
The octets to store.
Produces a Buffer backed by the same allocated memory as the given {ArrayBuffer}/{SharedArrayBuffer}.
since v10.0.0 - Use Buffer.from(arrayBuffer[, byteOffset[, length]]) instead.
The ArrayBuffer with which to share memory.
Allocates a new buffer containing the given {array} of octets.
since v10.0.0 - Use Buffer.from(array) instead.
The octets to store.
Copies the passed {buffer} data onto a new {Buffer} instance.
since v10.0.0 - Use Buffer.from(buffer) instead.
The buffer to copy.
Readonly BYTES_The size in bytes of each element in the array.
Readonly [toReadonly bufferThe ArrayBuffer instance referenced by the array.
Readonly byteThe length in bytes of the array.
Readonly byteThe offset in bytes of the array.
Readonly lengthThe length of the array.
Static Readonly BYTES_The size in bytes of each element in the array.
Static poolThis is the number of bytes used to determine the size of pre-allocated, internal Buffer instances used for pooling. This value may be modified.
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target
If target is negative, it is treated as length+target where length is the length of the array.
If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
Optional end: numberIf not specified, length of the this object is used as its default value.
Determines whether all the members of an array satisfy the specified test.
A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.
Optional thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Optional offset: numberOptional end: numberOptional encoding: BufferEncodingReturns the elements of an array that meet the condition specified in a callback function.
A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
Optional thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Returns the value of the first element in the array where predicate is true, and undefined otherwise.
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.
Optional thisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns the index of the first element in the array where predicate is true, and -1 otherwise.
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.
Optional thisArg: anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Performs the specified action for each element in an array.
A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
Optional thisArg: anyAn object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Optional byteOffset: numberOptional encoding: BufferEncodingOptional byteOffset: numberOptional encoding: BufferEncodingAdds all the elements of an array separated by the specified separator string.
Optional separator: stringA 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.
Optional byteOffset: numberOptional encoding: BufferEncodingCalls a defined callback function on each element of an array, and returns an array that contains the results.
A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
Optional thisArg: anyAn object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
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.
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
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.
A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
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.
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.
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
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.
A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
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 a new Buffer that references the same memory as the original, but offset and cropped by the start and end indices.
This method is incompatible with Uint8Array#slice(), which returns a copy of the original memory.
Optional begin: numberWhere the new Buffer will start. Default: 0.
Optional end: numberWhere the new Buffer will end (not inclusive). Default: buf.length.
Determines whether the specified callback function returns true for any element of an array.
A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.
Optional thisArg: anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.
Sorts an array.
Optional compareFn: ((a: number, b: number) => number)Function used to determine the order of the elements. It is expected to return a negative value if first argument is less than second argument, zero if they're equal and a positive value otherwise. If omitted, the elements are sorted in ascending order.
[11,2,22,1].sort((a, b) => a - b)
Returns a new Buffer that references the same memory as the original, but offset and cropped by the start and end indices.
This method is compatible with Uint8Array#subarray().
Optional begin: numberWhere the new Buffer will start. Default: 0.
Optional end: numberWhere the new Buffer will end (not inclusive). Default: buf.length.
Optional encoding: BufferEncodingOptional start: numberOptional end: numberOptional encoding: BufferEncodingOptional encoding: BufferEncodingOptional encoding: BufferEncodingStatic allocAllocates a new buffer of {size} octets.
count of octets to allocate.
Optional fill: string | number | Bufferif specified, buffer will be initialized by calling buf.fill(fill). If parameter is omitted, buffer will be filled with zeros.
Optional encoding: BufferEncodingencoding used for call to buf.fill while initalizing
Static allocStatic allocStatic byteGives the actual byte length of a string. encoding defaults to 'utf8'. This is not the same as String.prototype.length since that returns the number of characters in a string.
string to test.
Optional encoding: BufferEncodingencoding used to evaluate (defaults to 'utf8')
Static compareStatic concatReturns a buffer which is the result of concatenating all the buffers in the list together.
If the list has no items, or if the totalLength is 0, then it returns a zero-length buffer. If the list has exactly one item, then the first item of the list is returned. If the list has more than one item, then a new Buffer is created.
An array of Buffer objects to concatenate
Optional totalLength: numberTotal length of the buffers when concatenated. If totalLength is not provided, it is read from the buffers in the list. However, this adds an additional loop to the function, so it is faster to provide the length explicitly.
Static fromWhen passed a reference to the .buffer property of a TypedArray instance, the newly created Buffer will share the same allocated memory as the TypedArray. The optional {byteOffset} and {length} arguments specify a memory range within the {arrayBuffer} that will be shared by the Buffer.
The .buffer property of any TypedArray or a new ArrayBuffer()
Optional byteOffset: numberOptional length: numberCreates a new Buffer using the passed {data}
data to create a new Buffer
Creates a new Buffer containing the given JavaScript string {str}. If provided, the {encoding} parameter identifies the character encoding. If not provided, {encoding} defaults to 'utf8'.
Optional encoding: BufferEncodingStatic isStatic isReturns true if {encoding} is a valid encoding argument. Valid string encodings in Node 0.12: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'base64url'|'binary'(deprecated)|'hex'
string to test.
Static ofGenerated 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'|'base64url'|'binary'(deprecated)|'hex'