bare-buffer

stable

bare-buffer — Native buffers for JavaScript. It is a native addon and requires Bare >=1.20.0.

Mirrors the Node.js buffer module.

npm i bare-buffer

Usage

const Buffer = require('bare-buffer')

const message = Buffer.from('hello')
const empty = Buffer.alloc(16)
const buffer = Buffer.allocUnsafe(4).fill(123)
const combined = Buffer.concat([buffer, buffer])

API

Buffer

`new Buffer(arrayBuffer: ArrayBuffer, offset?: number, length?: number)`

_Source

Create a Buffer viewing arrayBuffer, optionally starting at offset for length bytes.

Parameters

Parameter	Type	Default	Description
`arrayBuffer`	`ArrayBuffer`	—	The `ArrayBuffer` to view.
`offset?`	`number`	—	Byte offset into `arrayBuffer` to start the view at; defaults to `0`.
`length?`	`number`	—	Number of bytes to view from `offset`; defaults to the rest of `arrayBuffer`.

Throws

RangeError — thrown if the resulting length would exceed Buffer.constants.MAX_LENGTH.

`Buffer.alloc(size: number, fill: string, encoding?: BufferEncoding): Buffer`

_Source

Allocate a new, zero-filled Buffer of size bytes, optionally filled with fill.

Overloads:

Buffer.alloc(size: number, fill: string, encoding?: BufferEncoding): Buffer
Buffer.alloc(size: number, fill?: Buffer | number | boolean): Buffer

Parameters

Parameter	Type	Default	Description
`size`	`number`	—	Number of bytes to allocate.
`fill`	`string`	—	Value to fill the buffer with — a string, `Buffer`, number byte, or boolean.
`encoding?`	`BufferEncoding`	—	Encoding used to interpret `fill` when it's a string; defaults to `'utf8'`.

Throws

RangeError — thrown if size exceeds Buffer.constants.MAX_LENGTH.

`Buffer.allocUnsafe(size: number): Buffer`

_Source

Allocate a new Buffer of size bytes without zeroing its contents first.

Parameters

Parameter	Type	Default	Description
`size`	`number`	—	Number of bytes to allocate.

Throws

RangeError — thrown if size exceeds Buffer.constants.MAX_LENGTH.

`Buffer.allocUnsafeSlow(size: number): Buffer`

_Source

Allocate a new Buffer of size bytes without zeroing its contents first, bypassing the internal buffer pool.

Parameters

Parameter	Type	Default	Description
`size`	`number`	—	Number of bytes to allocate.

Throws

RangeError — thrown if size exceeds Buffer.constants.MAX_LENGTH.

`Buffer.atob(data: unknown): string`

_Source

Decode a base64-encoded string into a Latin-1 binary string.

Parameters

Parameter	Type	Default	Description
`data`	`unknown`	—	The base64-encoded string to decode.

`Buffer.btoa(data: unknown): string`

_Source

Encode a Latin-1 binary string into a base64 string.

Parameters

Parameter	Type	Default	Description
`data`	`unknown`	—	The value to encode; non-strings are coerced with `String()`.

`Buffer.BufferEncoding`

type BufferEncoding = | 'ascii'
  | 'base64'
  | 'binary'
  | 'hex'
  | 'latin1'
  | 'ucs-2'
  | 'ucs2'
  | 'utf-16le'
  | 'utf-8'
  | 'utf16le'
  | 'utf8'

_Source

The set of encodings supported by Buffer methods that convert between bytes and strings.

`Buffer.byteLength`

Buffer.byteLength(string: ArrayBufferView | ArrayBufferLike | string, encoding?: BufferEncoding): number

_Source

Return the number of bytes string would occupy once encoded as encoding.

Parameters

Parameter	Type	Default	Description
`string`	`ArrayBufferView` \| `ArrayBufferLike` \| `string`	—	The value whose encoded length to measure — a string, or an `ArrayBufferView`/`ArrayBufferLike` (whose own `byteLength` is returned unchanged).
`encoding?`	`BufferEncoding`	—	Encoding used to measure `string` when it's a string; defaults to `'utf8'`.

Throws

Error — thrown if the encoding is not a recognized BufferEncoding.

`Buffer.coerce(buffer: Buffer): Buffer`

_Source

Return buffer unchanged if it is already a Buffer, otherwise wrap its underlying ArrayBuffer in a new Buffer.

Parameters

Parameter	Type	Default	Description
`buffer`	`Buffer`	—	The value to coerce into a `Buffer`.

`Buffer.compare(a: Buffer, b: Buffer): number`

_Source

Compare two buffers' contents lexicographically, returning -1, 0, or 1 for sort ordering.

Parameters

Parameter	Type	Default	Description
`a`	`Buffer`	—	The first buffer to compare.
`b`	`Buffer`	—	The second buffer to compare.

`Buffer.concat(buffers: Buffer[], length?: number): Buffer`

_Source

Concatenate buffers into a single new Buffer, optionally truncated or zero-padded to length.

Parameters

Parameter	Type	Default	Description
`buffers`	`Buffer[]`	—	The buffers to concatenate, in order.
`length?`	`number`	—	Total byte length of the result; defaults to the sum of `buffers`' lengths.

`Buffer.constants: { MAX_LENGTH: number; MAX_STRING_LENGTH: number }`

_Source

Limits for buffers and strings: MAX_LENGTH (largest possible Buffer) and MAX_STRING_LENGTH (largest possible string).

`Buffer.copyBytesFrom(view: ArrayBufferLike, offset?: number, length?: number): Buffer`

_Source

Copy the bytes of view, starting at offset for length elements, into a new Buffer.

Parameters

Parameter	Type	Default	Description
`view`	`ArrayBufferLike`	—	The typed array (or other `ArrayBufferLike` view) to copy bytes from.
`offset?`	`number`	—	Index of the first element to copy; defaults to `0`.
`length?`	`number`	—	Number of elements to copy; defaults to the rest of `view`.

Throws

RangeError — thrown if offset + length exceeds view.length.

`Buffer.from(data: Iterable<number>): Buffer`

_Source

Create a new Buffer from an array, array-like, string, or ArrayBuffer.

Overloads:

Buffer.from(data: Iterable<number>): Buffer
Buffer.from(data: ArrayLike<number>): Buffer
Buffer.from(string: string, encoding?: BufferEncoding): Buffer
Buffer.from(arrayBuffer: ArrayBufferLike, offset?: number, length?: number): Buffer

Parameters

Parameter	Type	Default	Description
`data`	`Iterable<number>`	—	The array, array-like, string, buffer, or `ArrayBuffer` to create a new `Buffer` from.

Throws

Error — thrown if the encoding is not a recognized BufferEncoding.

`Buffer.isAscii(buffer: Buffer): boolean`

_Source

Check whether buffer contains only valid ASCII-encoded data.

Parameters

Parameter	Type	Default	Description
`buffer`	`Buffer`	—	The buffer to check.

`Buffer.isASCII(buffer: Buffer): boolean`

_Source

Check whether buffer contains only valid ASCII-encoded data.

Parameters

Parameter	Type	Default	Description
`buffer`	`Buffer`	—	The buffer to check.

`Buffer.isBuffer(value: unknown): value is Buffer`

_Source

Check whether value is a Buffer.

Parameters

Parameter	Type	Default	Description
`value`	`unknown`	—	The value to check.

`Buffer.isEncoding(encoding: string): encoding is BufferEncoding`

_Source

Check whether encoding is a supported BufferEncoding.

Parameters

Parameter	Type	Default	Description
`encoding`	`string`	—	The encoding name to check.

`Buffer.isUtf8(buffer: Buffer): boolean`

_Source

Check whether buffer contains only valid UTF-8-encoded data.

Parameters

Parameter	Type	Default	Description
`buffer`	`Buffer`	—	The buffer to check.

`Buffer.isUTF8(buffer: Buffer): boolean`

_Source

Check whether buffer contains only valid UTF-8-encoded data.

Parameters

Parameter	Type	Default	Description
`buffer`	`Buffer`	—	The buffer to check.

`Buffer.poolSize: number`

_Source

The size, in bytes, of the internal buffer pool used to satisfy small allocations.

`Buffer.transcode(buffer: Buffer, from: BufferEncoding, to: BufferEncoding): Buffer`

_Source

Re-encode buffer from one encoding to another, returning a new Buffer.

Parameters

Parameter	Type	Default	Description
`buffer`	`Buffer`	—	The buffer to re-encode.
`from`	`BufferEncoding`	—	The encoding `buffer` is currently in.
`to`	`BufferEncoding`	—	The encoding to convert to.

Throws

Error — thrown if the encoding is not a recognized BufferEncoding.

`compare`

compare(target: Buffer, targetStart?: number, targetEnd?: number, sourceStart?: number, sourceEnd?: number): number

_Source

Compare two buffers' contents lexicographically, returning -1, 0, or 1 for sort ordering.

Parameters

Parameter	Type	Default	Description
`target`	`Buffer`	—	The buffer to compare against.
`targetStart?`	`number`	—	Offset within `target` to start comparing from; defaults to `0`.
`targetEnd?`	`number`	—	Offset within `target` (exclusive) to stop comparing at; defaults to `target.byteLength`.
`sourceStart?`	`number`	—	Offset within this buffer to start comparing from; defaults to `0`.
`sourceEnd?`	`number`	—	Offset within this buffer (exclusive) to stop comparing at; defaults to `this.byteLength`.

`copy(target: Buffer, targetStart?: number, sourceStart?: number, sourceEnd?: number): number`

_Source

Copy bytes from this buffer into target, returning the number of bytes copied.

Parameters

Parameter	Type	Default	Description
`target`	`Buffer`	—	The buffer to copy into.
`targetStart?`	`number`	—	Offset within `target` to start writing at; defaults to `0`.
`sourceStart?`	`number`	—	Offset within this buffer to start copying from; defaults to `0`.
`sourceEnd?`	`number`	—	Offset within this buffer (exclusive) to stop copying at; defaults to `this.byteLength`.

`equals(target: Buffer): boolean`

_Source

Check whether this buffer and target have identical contents.

Parameters

Parameter	Type	Default	Description
`target`	`Buffer`	—	The buffer to compare this buffer's contents against.

`fill(value: string, encoding?: BufferEncoding): this`

_Source

Fill this buffer with value, repeating as needed, and return it.

Overloads:

fill(value: string, encoding?: BufferEncoding): this
fill(value: string, offset?: number, encoding?: BufferEncoding): this
fill(value: string, offset?: number, end?: number, encoding?: BufferEncoding): this
fill(value: Buffer | number | boolean, offset?: number, end?: number): this

Parameters

Parameter	Type	Default	Description
`value`	`string`	—	The value to fill with — a string (repeated across the range), or a `Buffer`/number/boolean byte.
`encoding?`	`BufferEncoding`	—	Encoding used to interpret `value` when it's a string; defaults to `'utf8'`.

Throws

Error — thrown if the encoding is not a recognized BufferEncoding.

`includes(value: string, encoding?: BufferEncoding): boolean`

_Source

Check whether this buffer contains value.

Overloads:

includes(value: string, encoding?: BufferEncoding): boolean
includes(value: string, offset?: number, encoding?: BufferEncoding): boolean
includes(value: Buffer | number | boolean, offset?: number): boolean

Parameters

Parameter	Type	Default	Description
`value`	`string`	—	The value to search for — a string, `Buffer`, number byte, or boolean.
`encoding?`	`BufferEncoding`	—	Encoding used to interpret `value` when it's a string; defaults to `'utf8'`.

Throws

Error — thrown if the encoding is not a recognized BufferEncoding.

`indexOf(value: string, encoding?: BufferEncoding): number`

_Source

Return the first index at which value occurs in this buffer, or -1 if not found.

Overloads:

indexOf(value: string, encoding?: BufferEncoding): number
indexOf(value: string, offset?: number, encoding?: BufferEncoding): number
indexOf(value: Buffer | number | boolean, offset?: number): number

Parameters

Parameter	Type	Default	Description
`value`	`string`	—	The value to search for — a string, `Buffer`, number byte, or boolean.
`encoding?`	`BufferEncoding`	—	Encoding used to interpret `value` when it's a string; defaults to `'utf8'`.

Throws

Error — thrown if the encoding is not a recognized BufferEncoding.

`lastIndexOf(value: string, encoding?: BufferEncoding): number`

_Source

Return the last index at which value occurs in this buffer, or -1 if not found.

Overloads:

lastIndexOf(value: string, encoding?: BufferEncoding): number
lastIndexOf(value: string, offset?: number, encoding?: BufferEncoding): number
lastIndexOf(value: Buffer | number | boolean, offset?: number): number

Parameters

Parameter	Type	Default	Description
`value`	`string`	—	The value to search for — a string, `Buffer`, number byte, or boolean.
`encoding?`	`BufferEncoding`	—	Encoding used to interpret `value` when it's a string; defaults to `'utf8'`.

Throws

Error — thrown if the encoding is not a recognized BufferEncoding.

`readBigInt64BE(offset?: number): bigint`

_Source

Read a signed 64-bit big-endian integer at offset.

Parameters

Parameter	Type	Default	Description
`offset?`	`number`	—	Byte offset to read from; defaults to `0`.

`readBigInt64LE(offset?: number): bigint`

_Source

Read a signed 64-bit little-endian integer at offset.

Parameters

Parameter	Type	Default	Description
`offset?`	`number`	—	Byte offset to read from; defaults to `0`.

`readBigUint64BE(offset?: number): bigint`

_Source

Read an unsigned 64-bit big-endian integer at offset.

Parameters

Parameter	Type	Default	Description
`offset?`	`number`	—	Byte offset to read from; defaults to `0`.

`readBigUInt64BE(offset?: number): bigint`

_Source

Read an unsigned 64-bit big-endian integer at offset.

Parameters

Parameter	Type	Default	Description
`offset?`	`number`	—	Byte offset to read from; defaults to `0`.

`readBigUint64LE(offset?: number): bigint`

_Source

Read an unsigned 64-bit little-endian integer at offset.

Parameters

Parameter	Type	Default	Description
`offset?`	`number`	—	Byte offset to read from; defaults to `0`.

`readBigUInt64LE(offset?: number): bigint`

_Source

Read an unsigned 64-bit little-endian integer at offset.

Parameters

Parameter	Type	Default	Description
`offset?`	`number`	—	Byte offset to read from; defaults to `0`.

`readDoubleBE(offset?: number): number`

_Source

Read a 64-bit big-endian double at offset.

Parameters

Parameter	Type	Default	Description
`offset?`	`number`	—	Byte offset to read from; defaults to `0`.

`readDoubleLE(offset?: number): number`

_Source

Read a 64-bit little-endian double at offset.

Parameters

Parameter	Type	Default	Description
`offset?`	`number`	—	Byte offset to read from; defaults to `0`.

`readFloatBE(offset?: number): number`

_Source

Read a 32-bit big-endian float at offset.

Parameters

Parameter	Type	Default	Description
`offset?`	`number`	—	Byte offset to read from; defaults to `0`.

`readFloatLE(offset?: number): number`

_Source

Read a 32-bit little-endian float at offset.

Parameters

Parameter	Type	Default	Description
`offset?`	`number`	—	Byte offset to read from; defaults to `0`.

`readInt16BE(offset?: number): number`

_Source

Read a signed 16-bit big-endian integer at offset.

Parameters

Parameter	Type	Default	Description
`offset?`	`number`	—	Byte offset to read from; defaults to `0`.

`readInt16LE(offset?: number): number`

_Source

Read a signed 16-bit little-endian integer at offset.

Parameters

Parameter	Type	Default	Description
`offset?`	`number`	—	Byte offset to read from; defaults to `0`.

`readInt32BE(offset?: number): number`

_Source

Read a signed 32-bit big-endian integer at offset.

Parameters

Parameter	Type	Default	Description
`offset?`	`number`	—	Byte offset to read from; defaults to `0`.

`readInt32LE(offset?: number): number`

_Source

Read a signed 32-bit little-endian integer at offset.

Parameters

Parameter	Type	Default	Description
`offset?`	`number`	—	Byte offset to read from; defaults to `0`.

`readInt8(offset?: number): number`

_Source

Read a signed 8-bit integer at offset.

Parameters

Parameter	Type	Default	Description
`offset?`	`number`	—	Byte offset to read from; defaults to `0`.

`readIntBE(offset: number, byteLength: number): number`

_Source

Read a signed, big-endian, byteLength-byte integer at offset.

Parameters

Parameter	Type	Default	Description
`offset`	`number`	—	Byte offset to read from.
`byteLength`	`number`	—	Number of bytes to read, from `1` to `6`.

Throws

RangeError — thrown if byteLength is not between 1 and 6.

`readIntLE(offset: number, byteLength: number): number`

_Source

Read a signed, little-endian, byteLength-byte integer at offset.

Parameters

Parameter	Type	Default	Description
`offset`	`number`	—	Byte offset to read from.
`byteLength`	`number`	—	Number of bytes to read, from `1` to `6`.

Throws

RangeError — thrown if byteLength is not between 1 and 6.

`readUint16BE(offset?: number): number`

_Source

Read an unsigned 16-bit big-endian integer at offset.

Parameters

Parameter	Type	Default	Description
`offset?`	`number`	—	Byte offset to read from; defaults to `0`.

`readUInt16BE(offset?: number): number`

_Source

Read an unsigned 16-bit big-endian integer at offset.

Parameters

Parameter	Type	Default	Description
`offset?`	`number`	—	Byte offset to read from; defaults to `0`.

`readUint16LE(offset?: number): number`

_Source

Read an unsigned 16-bit little-endian integer at offset.

Parameters

Parameter	Type	Default	Description
`offset?`	`number`	—	Byte offset to read from; defaults to `0`.

`readUInt16LE(offset?: number): number`

_Source

Read an unsigned 16-bit little-endian integer at offset.

Parameters

Parameter	Type	Default	Description
`offset?`	`number`	—	Byte offset to read from; defaults to `0`.

`readUint32BE(offset?: number): number`

_Source

Read an unsigned 32-bit big-endian integer at offset.

Parameters

Parameter	Type	Default	Description
`offset?`	`number`	—	Byte offset to read from; defaults to `0`.

`readUInt32BE(offset?: number): number`

_Source

Read an unsigned 32-bit big-endian integer at offset.

Parameters

Parameter	Type	Default	Description
`offset?`	`number`	—	Byte offset to read from; defaults to `0`.

`readUint32LE(offset?: number): number`

_Source

Read an unsigned 32-bit little-endian integer at offset.

Parameters

Parameter	Type	Default	Description
`offset?`	`number`	—	Byte offset to read from; defaults to `0`.

`readUInt32LE(offset?: number): number`

_Source

Read an unsigned 32-bit little-endian integer at offset.

Parameters

Parameter	Type	Default	Description
`offset?`	`number`	—	Byte offset to read from; defaults to `0`.

`readUint8(offset?: number): number`

_Source

Read an unsigned 8-bit integer at offset.

Parameters

Parameter	Type	Default	Description
`offset?`	`number`	—	Byte offset to read from; defaults to `0`.

`readUInt8(offset?: number): number`

_Source

Read an unsigned 8-bit integer at offset.

Parameters

Parameter	Type	Default	Description
`offset?`	`number`	—	Byte offset to read from; defaults to `0`.

`readUintBE(offset: number, byteLength: number): number`

_Source

Read an unsigned, big-endian, byteLength-byte integer at offset.

Parameters

Parameter	Type	Default	Description
`offset`	`number`	—	Byte offset to read from.
`byteLength`	`number`	—	Number of bytes to read, from `1` to `6`.

Throws

RangeError — thrown if byteLength is not between 1 and 6.

`readUIntBE(offset: number, byteLength: number): number`

_Source

Read an unsigned, big-endian, byteLength-byte integer at offset.

Parameters

Parameter	Type	Default	Description
`offset`	`number`	—	Byte offset to read from.
`byteLength`	`number`	—	Number of bytes to read, from `1` to `6`.

Throws

RangeError — thrown if byteLength is not between 1 and 6.

`readUintLE(offset: number, byteLength: number): number`

_Source

Read an unsigned, little-endian, byteLength-byte integer at offset.

Parameters

Parameter	Type	Default	Description
`offset`	`number`	—	Byte offset to read from.
`byteLength`	`number`	—	Number of bytes to read, from `1` to `6`.

Throws

RangeError — thrown if byteLength is not between 1 and 6.

`readUIntLE(offset: number, byteLength: number): number`

_Source

Read an unsigned, little-endian, byteLength-byte integer at offset.

Parameters

Parameter	Type	Default	Description
`offset`	`number`	—	Byte offset to read from.
`byteLength`	`number`	—	Number of bytes to read, from `1` to `6`.

Throws

RangeError — thrown if byteLength is not between 1 and 6.

`swap16(): this`

_Source

Swap the byte order of each 16-bit group in this buffer in place, and return it.

Throws

RangeError — thrown if the buffer's length is not a multiple of 2 bytes.

`swap32(): this`

_Source

Swap the byte order of each 32-bit group in this buffer in place, and return it.

Throws

RangeError — thrown if the buffer's length is not a multiple of 4 bytes.

`swap64(): this`

_Source

Swap the byte order of each 64-bit group in this buffer in place, and return it.

Throws

RangeError — thrown if the buffer's length is not a multiple of 8 bytes.

`toJSON(): number[]`

_Source

Return an array of this buffer's bytes, used when the buffer is passed to JSON.stringify().

`toString(encoding?: BufferEncoding, start?: number, end?: number): string`

_Source

Decode this buffer (or a slice of it) to a string using encoding.

Parameters

Parameter	Type	Default	Description
`encoding?`	`BufferEncoding`	—	Encoding used to decode the bytes; defaults to `'utf8'`.
`start?`	`number`	—	Byte offset to start decoding from; defaults to `0`.
`end?`	`number`	—	Byte offset (exclusive) to stop decoding at; defaults to `this.byteLength`.

Throws

Error — thrown if the encoding is not a recognized BufferEncoding.

`write(string: string, encoding?: BufferEncoding): number`

_Source

Write string into this buffer using encoding, returning the number of bytes written.

Overloads:

write(string: string, encoding?: BufferEncoding): number
write(string: string, offset?: number, encoding?: BufferEncoding): number
write(string: string, offset?: number, length?: number, encoding?: BufferEncoding): number

Parameters

Parameter	Type	Default	Description
`string`	`string`	—	The string to write.
`encoding?`	`BufferEncoding`	—	Encoding used to encode `string`; defaults to `'utf8'`.

Throws

Error — thrown if the encoding is not a recognized BufferEncoding.

`writeBigInt64BE(value: bigint, offset?: number): number`

_Source

Write a signed 64-bit big-endian integer at offset.

Parameters

Parameter	Type	Default	Description
`value`	`bigint`	—	The signed `bigint` to write.
`offset?`	`number`	—	Byte offset to write to; defaults to `0`.