Node.js - Buffer Module

buf.buffer

It will give you an object of array buffer and the buffer created from it will be the same as the array buffer.

buf.byteOffset

It will give you an byteOffset value of the given buffer.

buf.length

It will give you the no of bytes in the buffer.

Buffer.poolSize

It allocates the size in bytes towards Buffer instances which are later used by NodeJs for pooling.

buf[index]

It helps to set or return the octet value at the index position in a buffer.

alloc()

Used to create a new buffer with the given size.

allocUnsafe()

Used to allocate a new buffer with size given. If size larger than buffer.constants.MAX_LENGTH or lesser than 0, ERR_INVALID_ARG_VALUE will be thrown.

allocUnsafeSlow()

It will allocate a new buffer with given size. If size is larger than buffer.constants.MAX_LENGTH or lesser than 0, ERR_INVALID_ARG_VALUE will be thrown.

byteLength()

Used to return the length in bytes for the buffer object.

compare()

Used to compare two given buffer objects and returns a value that states the difference in comparison.

concat()

Used to return a single buffer object by concatenating all the given buffer objects

from()

Used to create a new buffer using the array passed as bytes.

isBuffer()

It returns the true if the object given is a buffer.

isEncoding()

It returns true if the given encoding value is a supported character encoding and false if not.

readBigInt64LE()

Used to read a signed 64-bit integer at a given offset from the buffer in little endian form.

compare()

Used to deal with the comparison of two buffer objects and returns a value that states the difference in comparison.

readBigInt64BE()

Used to read a signed big endian 64-bit integer at a given offset from a buffer object.

lastIndexOf()

It takes care of searching a value inside the buffer. It returns the position at which the value is present and -1 if the value is not present.

readBigUInt64LE()

Used to read an unsigned little-endian 64-bit integer at a given offset from the current buffer object.

readDoubleBE()

Used to read a big-endian double 64-bit number at a given offset from the current buffer object.

readDoubleLE()

Used to read a little-endian double 64-bit number at a given offset from the current buffer object.

readFloatBE()

Used to read a big-endian float 32-bit number at a given offset from the current buffer object.

readFloatLE()

Used to read a little-endian float 32-bit number at a given offset from the current buffer object.

readInt8()

Used to read a 8-bit signed number at a given offset from the current buffer object.

writeDoubleBE()

Used to write a big-endian double number at a given offset to the buffer created.

writeDoubleLE()

Used to write a little-endian double number at a given offset to the buffer created.

writeFloatBE()

Used to write a big-endian float 32-bit number at a given offset to the current buffer object.

writeFloatLE()

Used to write a little-endian float 32-bit number at a given offset to the current buffer object.

copy()

Used to copy the contents of the source buffer object into the target buffer.

entries()

Used to create an iterator object from the buffer given and returns back a pair with [index, byte] from the contents of the buffer.

equals()

Used to compare two buffers and returns true if it's equal and false if not.

fill()

Used to fill the buffer with the given value . If the range inside the buffer is not specified it will fill the entire buffer.

includes()

Used to check if the given value is available inside or included in the buffer. It returns true if present and false if not.

indexOf()

It takes care of searching a value inside the buffer. It returns the position at which the value starts and -1 if the value is not present.

keys()

Used to return an iterator object. When looped through that object , it will give the key for each byte in the buffer object.

readBigUInt64BE()

Used to read an unsigned big-endian 64-bit integer at a given offset from the current buffer object.

readInt16BE()

Used to read a signed 16-bit integer at a given offset from the buffer in big endian form.

readInt16LE()

Used to read a signed 16-bit integer at a given offset from the buffer in little endian form.

readInt32BE()

Used to read a signed 32-bit integer at a given offset from the buffer in big endian form.

readInt32LE()

Used to read a signed 32-bit integer at a given offset from the buffer in little endian form.

readIntBE()

Used to read a number of bytes in big endian format from a buffer at a given offset.

readIntLE()

Used to read a number of bytes in little endian format from a buffer at a given offset.

readUInt8()

Used to read a 8-bit unsigned number at a given offset from the current buffer object.

readUInt16BE()

Used to read an unsigned 16-bit integer at a given offset from the buffer in big endian form.

readUInt16LE()

Used to read an unsigned 16-bit integer at a given offset from the buffer in little endian form.

readUInt32BE()

Used to read an unsigned 32-bit integer at a given offset from the buffer in big endian form.

readUInt32LE()

Used to read an unsigned 32-bit integer at a given offset from the buffer in little endian form.

readUIntBE()

Used to read a number of bytes as per the byte length and offset and return the unsigned integer in big endian format from a buffer used.

readUIntLE()

Used to read a number of bytes as per the byte length and offset and return the unsigned integer in little endian format from a buffer used.

subarray()

Used to return a new buffer based on given start and end offset values on the original buffer.

swap16(), swap32(), swap64()

These considers the buffer as an array of unsigned 16 or 32 or 64 bit integers and swaps the byte order in-place and returns a reference to the buffer.

toJSON()

Used to return a JSON object for the given buffer.

toString()

Used to decode the string as per the encoding given.

values()

Used to return an iterator object that has details of all the bytes present in the buffer.

write()

Used to write the given string value to the buffer from the position given by the offset value.

writeBigInt64BE()

Used to write a signed 64-bit integer at a given offset to the buffer in big endian form.

writeBigInt64LE()

Used to write a signed 64-bit integer at a given offset to the buffer in little endian form.

writeBigUInt64LE()

Used to write an unsigned 64-bit integer at a given offset to the buffer in little endian form.

writeInt8()

Used to write an signed 8-bit integer of value at a given offset to the buffer.

writeInt16BE()

Used to write a signed 16-bit integer at a given offset to the buffer in big endian form.

writeInt16LE()

Used to write a signed 16-bit integer at a given offset to the buffer in little endian form.

writeInt32BE()

Used to write a signed 32-bit integer at a given offset to the buffer in big endian form.

writeInt32LE()

Used to write a signed 32-bit integer at a given offset to the buffer in little endian form.

writeIntBE()

Used to write a byte length bytes of value at a given offset to the buffer in big endian form.

writeIntLE()

Used to write a bytelength bytes of value at a given offset to the buffer in little endian form.

writeUInt8()

Used to write an unsigned 8-bit integer of value at a given offset to the buffer.

writeUInt16BE()

Used to write a bytelength of an unsigned 16-bit integer of value at a given offset to the buffer in big endian form.

writeUInt16LE()

Used to write an unsigned 16-bit integer of value at a given offset to the buffer in little endian form.

writeUInt32BE()

Used to write an unsigned 32-bit integer of value at a given offset to the buffer in big endian form.

writeUInt32LE()

Used to write an unsigned 32-bit integer of value at a given offset to the buffer in little endian form.

writeUIntBE()

Used to write a bytelength of unsigned bytes of value at a given offset to the buffer in big endian form.

writeUIntLE()

Used to write a bytelength of unsigned bytes of value at a given offset to the buffer in little endian form.