Class BytesIO

A class for reading and writing binary data using Node.js Buffers, similar to Python's BytesIO. Provides methods for seeking, slicing, reading, and writing various data types.

Remarks

This class is useful for manipulating binary data in memory, supporting random access and reading/writing of integers, floats, and raw buffers.

Example

const bio = BytesIO.from([1, 2, 3, 4]);
bio.seek(0);
const value = bio.readInt32LE();

Index

Constructors

constructor

Accessors

buffer length post

Constructors

constructor

new BytesIO(buffer?: Buffer): BytesIO
Parameters
- buffer: Buffer = ...
Returns BytesIO
- Defined in src/BytesIO.ts:34

Accessors

buffer

get buffer(): Buffer
Gets the underlying Buffer.

Returns Buffer
- Defined in src/BytesIO.ts:291

length

get length(): number
Gets the length of the buffer in bytes.

Returns number
- Defined in src/BytesIO.ts:285

post

get post(): number
Gets the current pointer position.

Returns number
- Defined in src/BytesIO.ts:297

Methods

read

read(length?: number): Buffer
Reads a specified number of bytes from the current pointer. Advances the pointer by the number of bytes read.
Parameters
- Optionallength: number
  
  The number of bytes to read. If undefined, reads to the end.
Returns Buffer

A Buffer containing the read bytes.
- Defined in src/BytesIO.ts:100

readBigInt64BE

readBigInt64BE(size?: number): bigint
Reads a 64-bit signed integer (big-endian) from the current pointer. Advances the pointer by 8 bytes (or specified size).
Parameters
- size: number = 8
  
  Number of bytes to advance the pointer. Defaults to 8.
Returns bigint

The read bigint.
- Defined in src/BytesIO.ts:174

readBigInt64LE

readBigInt64LE(size?: number): bigint
Reads a 64-bit signed integer (little-endian) from the current pointer. Advances the pointer by 8 bytes (or specified size).
Parameters
- size: number = 8
  
  Number of bytes to advance the pointer. Defaults to 8.
Returns bigint

The read bigint.
- Defined in src/BytesIO.ts:163

readBigUInt64BE

readBigUInt64BE(size?: number): bigint
Reads a 64-bit unsigned integer (big-endian) from the current pointer. Advances the pointer by 8 bytes (or specified size).
Parameters
- size: number = 8
  
  Number of bytes to advance the pointer. Defaults to 8.
Returns bigint

The read bigint.
- Defined in src/BytesIO.ts:196

readBigUInt64LE

readBigUInt64LE(size?: number): bigint
Reads a 64-bit unsigned integer (little-endian) from the current pointer. Advances the pointer by 8 bytes (or specified size).
Parameters
- size: number = 8
  
  Number of bytes to advance the pointer. Defaults to 8.
Returns bigint

The read bigint.
- Defined in src/BytesIO.ts:185

readDoubleBE

readDoubleBE(size?: number): number
Reads a 64-bit floating point number (big-endian) from the current pointer. Advances the pointer by 8 bytes (or specified size).
Parameters
- size: number = 8
  
  Number of bytes to advance the pointer. Defaults to 8.
Returns number

The read double.
- Defined in src/BytesIO.ts:218

readDoubleLE

readDoubleLE(size?: number): number
Reads a 64-bit floating point number (little-endian) from the current pointer. Advances the pointer by 8 bytes (or specified size).
Parameters
- size: number = 8
  
  Number of bytes to advance the pointer. Defaults to 8.
Returns number

The read double.
- Defined in src/BytesIO.ts:207

readFloatBE

readFloatBE(size?: number): number
Reads a 32-bit floating point number (big-endian) from the current pointer. Advances the pointer by 4 bytes (or specified size).
Parameters
- size: number = 4
  
  Number of bytes to advance the pointer. Defaults to 4.
Returns number

The read float.
- Defined in src/BytesIO.ts:240

readFloatLE

readFloatLE(size?: number): number
Reads a 32-bit floating point number (little-endian) from the current pointer. Advances the pointer by 4 bytes (or specified size).
Parameters
- size: number = 4
  
  Number of bytes to advance the pointer. Defaults to 4.
Returns number

The read float.
- Defined in src/BytesIO.ts:229

readInt32BE

readInt32BE(size?: number): number
Reads a 32-bit signed integer (big-endian) from the current pointer. Advances the pointer by 4 bytes (or specified size).
Parameters
- size: number = 4
  
  Number of bytes to advance the pointer. Defaults to 4.
Returns number

The read integer.
- Defined in src/BytesIO.ts:130

readInt32LE

readInt32LE(size?: number): number
Reads a 32-bit signed integer (little-endian) from the current pointer. Advances the pointer by 4 bytes (or specified size).
Parameters
- size: number = 4
  
  Number of bytes to advance the pointer. Defaults to 4.
Returns number

The read integer.
- Defined in src/BytesIO.ts:119

readUInt32BE

readUInt32BE(size?: number): number
Reads a 32-bit unsigned integer (big-endian) from the current pointer. Advances the pointer by 4 bytes (or specified size).
Parameters
- size: number = 4
  
  Number of bytes to advance the pointer. Defaults to 4.
Returns number

The read unsigned integer.
- Defined in src/BytesIO.ts:152

readUInt32LE

readUInt32LE(size?: number): number
Reads a 32-bit unsigned integer (little-endian) from the current pointer. Advances the pointer by 4 bytes (or specified size).
Parameters
- size: number = 4
  
  Number of bytes to advance the pointer. Defaults to 4.
Returns number

The read unsigned integer.
- Defined in src/BytesIO.ts:141

seek

seek(offset: number, whence?: number): number
Moves the internal pointer to a new position.
Parameters
- offset: number
  
  The offset to move the pointer.
- whence: number = 0
  
  The reference point: 0 (start), 1 (current), 2 (end).
Returns number

The new pointer position.

Throws

If the offset or whence is invalid.
- Defined in src/BytesIO.ts:46

slice

slice(...args: any[]): BytesIO
Returns a new BytesIO instance containing a slice of the buffer.
Parameters
- ...args: any[]
  
  Arguments passed to Buffer.subarray.
Returns BytesIO

A new BytesIO instance with the sliced buffer.
- Defined in src/BytesIO.ts:76

toJSON

toJSON(): { data: number[]; type: "Buffer" }
Returns a JSON representation of the buffer.

Returns { data: number[]; type: "Buffer" }

The buffer as a JSON object.
- Defined in src/BytesIO.ts:83

toString

toString(...args: any[]): string
Returns a string representation of the buffer.
Parameters
- ...args: any[]
  
  Arguments passed to Buffer.toString.
Returns string

The buffer as a string.
- Defined in src/BytesIO.ts:91

write

write(data: Buffer): BytesIO
Appends data to the end of the buffer.
Parameters
- data: Buffer
  The Buffer to append.
Returns BytesIO

The BytesIO instance (for chaining).
- Defined in src/BytesIO.ts:250

`Static`alloc

alloc(size: number): BytesIO
Allocates a new BytesIO instance with a buffer of the given size.
Parameters
- size: number
  
  The size of the buffer to allocate.
Returns BytesIO

A new BytesIO instance.
- Defined in src/BytesIO.ts:262

`Static`concat

concat(data: Buffer<ArrayBufferLike>[]): BytesIO
Concatenates an array of Buffers into a new BytesIO instance.
Parameters
- data: Buffer<ArrayBufferLike>[]
  
  The array of Buffers to concatenate.
Returns BytesIO

A new BytesIO instance.
- Defined in src/BytesIO.ts:279

`Static`from

from(input: any, encode?: any): BytesIO
Creates a new BytesIO instance from the given input.
Parameters
- input: any
  
  The input data (Buffer, Array, string, etc.).
- Optionalencode: any
  
  Optional encoding if input is a string.
Returns BytesIO

A new BytesIO instance.
- Defined in src/BytesIO.ts:271

Class BytesIO

Remarks

Example

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns BytesIO

Accessors

buffer

Returns Buffer

length

Returns number

post

Returns number

Methods

read

Parameters

Returns Buffer

readBigInt64BE

Parameters

Returns bigint

readBigInt64LE

Parameters

Returns bigint

readBigUInt64BE

Parameters

Returns bigint

readBigUInt64LE

Parameters

Returns bigint

readDoubleBE

Parameters

Returns number

readDoubleLE

Parameters

Returns number

readFloatBE

Parameters

Returns number

readFloatLE

Parameters

Returns number

readInt32BE

Parameters

Returns number

readInt32LE

Parameters

Returns number

readUInt32BE

Parameters

Returns number

readUInt32LE

Parameters

Returns number

seek

Parameters

Returns number

Throws

slice

Parameters

Returns BytesIO

toJSON

Returns { data: number[]; type: "Buffer" }

toString

Parameters

Returns string

write

Parameters

Returns BytesIO

Staticalloc

Parameters

Returns BytesIO

Staticconcat

Parameters

Returns BytesIO

Staticfrom

`Static`alloc

`Static`concat

`Static`from