Class BinaryStream

constructor

• new BinaryStream(buffer, offset?): BinaryStream

• Creates a new BinaryStream instance.

  Parameters

  • buffer: Uint8Array | number[]

    The initial buffer for the stream.
  • Optional offset: number

    The initial offset for the stream.

  Returns BinaryStream
• new BinaryStream(buffer, offset?): BinaryStream

• Parameters

  • buffer: ArrayBuffer
  • Optional offset: number

  Returns BinaryStream

• new BinaryStream(size): BinaryStream

• Parameters

  • size: number

  Returns BinaryStream

• new BinaryStream(): BinaryStream

• Returns BinaryStream

offset

readBigUInt64

readBoolean

readByte

readDouble

readDoubleBE

readDoubleLE

readFloat

readFloat32

readFloat64

readFloatBE

readFloatLE

readInt

readInt16

readInt32

readIntBE

readIntLE

readLong

readLongBE

readLongLE

readShort

readShortBE

readShortLE

readTriad

readUInt

readUInt16

readUInt32

readUIntBE

readUIntLE

readUShort

readUShortBE

readUShortLE

writeBigUInt64

writeBoolean

writeByte

writeDouble

writeDoubleBE

writeDoubleLE

writeFloat

writeFloat32

writeFloat64

writeFloatBE

writeFloatLE

writeInt

writeInt16

writeInt32

writeIntBE

writeIntLE

writeLong

writeLongBE

writeLongLE

writeShort

writeShortBE

writeShortLE

writeTriad

writeUInt

writeUInt16

writeUInt32

writeUIntBE

writeUIntLE

writeUShort

writeUShortBE

writeUShortLE

buffer

• get buffer(): Uint8Array

• Gets a copy of the underlying ArrayBuffer as a Uint8Array.

  Returns Uint8Array

  A copy of the ArrayBuffer.

length

• get length(): number

• Gets the size of the buffer.

  Returns number

  The size of the buffer.

blob

• blob(type?): Blob

• Creates a Blob from the buffer.

  Parameters

  • Optional type: string

    The MIME type of the Blob.

  Returns Blob

  The created Blob object.

equals

• equals(stream): boolean

• Checks if the current stream is equal to another stream or Uint8Array.

  Parameters

  • stream: Uint8Array | BinaryStream

    The stream or Uint8Array to compare.

  Returns boolean

  True if the streams are equal, false otherwise.

feof

• feof(): boolean

• Checks if the current offset has reached the end of the binary stream.

  Returns boolean

  A boolean indicating whether the end of the stream has been reached.

flip

• flip(): this

• Flips the binary stream by resetting the offset to 0.

  Returns this

  The updated BinaryStream instance.

getDataView

• getDataView(): DataView

• Gets the underlying DataView of the stream.

  Returns DataView

  The DataView object.

getRemainingBytes

• getRemainingBytes(): number

• Gets the amount of remaining bytes that can be read.

  Returns number

  The number of remaining bytes.

increaseOffset

• increaseOffset(length, offset?): {
      end: number;
      start: number;
  }

• Increases the offset of the stream and returns the start and end offsets.

  Parameters

  • length: number

    The length to increase the offset by.
  • Optional offset: number

    The optional offset to set.

  Returns {
      end: number;
      start: number;
  }

  An object containing the start and end offsets.

  • end: number

  • start: number

read

• read(length, offset?): Uint8Array

• Reads a set of bytes from the buffer.

  Parameters

  • length: number

    The number of bytes to read.
  • Optional offset: number

    The optional offset to read from.

  Returns Uint8Array

  A Uint8Array containing the read bytes.

  Throws

  RangeError if the read operation exceeds the buffer length.

readAddress

• readAddress(offset?): InternetAddress

• Reads an Internet address from the binary stream.

  Parameters

  • Optional offset: number

    The optional offset to read from.

  Returns InternetAddress

  An object representing the Internet address, including the address, port, and version.

readBigUInt64BE

• readBigUInt64BE(offset?): bigint

• Reads an unsigned 64-bit big-endian integer from the binary stream.

  Parameters

  • Optional offset: number

    The optional offset to read from.

  Returns bigint

  The unsigned 64-bit big-endian integer read from the binary stream.

readBigUInt64LE

• readBigUInt64LE(offset?): bigint

• Reads an unsigned 64-bit little-endian integer from the binary stream.

  Parameters

  • Optional offset: number

    The optional offset to read from.

  Returns bigint

  The unsigned 64-bit little-endian integer read from the binary stream.

readBool

• readBool(offset?): boolean

• Reads a boolean value.

  Parameters

  • Optional offset: number

    The optional offset to read from.

  Returns boolean

  boolean value.

readFloat32BE

• readFloat32BE(offset?): number

• Reads a 32-bit floating point number in big-endian format from the binary stream.

  Parameters

  • Optional offset: number

    The optional offset to read from.

  Returns number

  The 32-bit floating point number read from the binary stream.

readFloat32LE

• readFloat32LE(offset?): number

• Reads a 32-bit floating-point number in little-endian format from the binary stream.

  Parameters

  • Optional offset: number

    The optional offset to read from.

  Returns number

  The 32-bit floating-point number read from the binary stream.

readFloat64BE

• readFloat64BE(offset?): number

• Reads an 8-byte floating-point number in big-endian format from the binary stream.

  Parameters

  • Optional offset: number

    The optional offset to read from. If not provided, the current offset will be used.

  Returns number

  The 8-byte floating-point number read from the binary stream.

readFloat64LE

• readFloat64LE(offset?): number

• Reads an 8-byte floating-point number in little-endian format from the binary stream.

  Parameters

  • Optional offset: number

    The optional offset to read from.

  Returns number

  The 8-byte floating-point number read from the binary stream.

readInt16BE

• readInt16BE(offset?): number

• Reads a 16-bit signed big-endian number.

  Parameters

  • Optional offset: number

    The optional offset to read from.

  Returns number

  The read 16-bit signed big-endian number.

readInt16LE

• readInt16LE(offset?): number

• Reads a 16-bit signed little-endian number.

  Parameters

  • Optional offset: number

    The optional offset to read from.

  Returns number

  The read 16-bit signed little-endian number.

readInt32BE

• readInt32BE(offset?): number

• Reads a 32-bit signed big-endian number

  Parameters

  • Optional offset: number

  Returns number

readInt32LE

• readInt32LE(offset?): number

• Reads a 32-bit signed little-endian number

  Parameters

  • Optional offset: number

  Returns number

readInt8

• readInt8(offset?): number

• Reads a signed 8-bit number.

  Parameters

  • Optional offset: number

    The optional offset to read from.

  Returns number

  The read signed 8-bit number.

readRemainingBytes

• readRemainingBytes(): Uint8Array

• Reads the remaining amount of bytes.

  Returns Uint8Array

  A Uint8Array containing the remaining bytes.

readString

• readString(offset?): string

• Reads a string from the buffer

  Parameters

  • Optional offset: number

  Returns string

readTriadBE

• readTriadBE(offset?): number

• Reads a 3-byte big-endian number.

  Parameters

  • Optional offset: number

    The optional offset to read from.

  Returns number

  The read 3-byte big-endian number.

readTriadLE

• readTriadLE(offset?): number

• Reads a 3-byte little-endian number.

  Parameters

  • Optional offset: number

    The optional offset to read from.

  Returns number

  The read 3-byte little-endian number.

readUInt16BE

• readUInt16BE(offset?): number

• Reads a 16-bit unsigned big-endian number.

  Parameters

  • Optional offset: number

    The optional offset to read from.

  Returns number

  The read 16-bit unsigned big-endian number.

readUInt16LE

• readUInt16LE(offset?): number

• Reads a 16-bit unsigned little-endian number.

  Parameters

  • Optional offset: number

    The optional offset to read from.

  Returns number

  The read 16-bit unsigned little-endian number.

readUInt32BE

• readUInt32BE(offset?): number

• Reads a 32-bit unsigned big-endian number.

  Parameters

  • Optional offset: number

    The optional offset to read from.

  Returns number

  The read 32-bit unsigned big-endian number.

readUInt32LE

• readUInt32LE(offset?): number

• Reads a 32-bit unsigned little-endian number

  Parameters

  • Optional offset: number

  Returns number

readUInt8

• readUInt8(offset?): number

• Reads an unsigned 8-bit number.

  Parameters

  • Optional offset: number

    The optional offset to read from.

  Returns number

  The read unsigned 8-bit number.

readUVarInt

• readUVarInt(offset?): number

• Reads an unsigned variable-length integer from the binary stream.

  Parameters

  • Optional offset: number

    The optional offset to read from.

  Returns number

  The unsigned variable-length integer read from the stream.

readUVarLong

• readUVarLong(offset?): bigint

• Reads an unsigned variable-length long integer from the binary stream.

  Parameters

  • Optional offset: number

    The optional offset to read from.

  Returns bigint

  The unsigned variable-length long integer read from the stream.

readVarInt

• readVarInt(offset?): number

• Reads a variable-length integer from the binary stream.

  Parameters

  • Optional offset: number

    The optional offset to read from.

  Returns number

  The read variable-length integer.

readVarLong

• readVarLong(offset?): bigint

• Reads a variable-length long integer from the binary stream.

  Parameters

  • Optional offset: number

    The optional offset to read from.

  Returns bigint

  The read long integer value.

reset

• reset(): this

• Resets the stream's buffer.

  Returns this

  The updated BinaryStream instance.

resize

• resize(size, canShrink?): this

• Resizes the buffer of the stream.

  Parameters

  • size: number

    The new size of the buffer.
  • Optional canShrink: boolean

    Whether the buffer can be shrunk.

  Returns this

  The updated BinaryStream instance.

setBuffer

• setBuffer(buffer, offset?): this

• Sets the buffer and/or offset of the stream.

  Parameters

  • buffer: Uint8Array | number[]

    The buffer to set.
  • Optional offset: number

    The optional offset to set.

  Returns this

  The updated BinaryStream instance.

split

• split(bytes): Uint8Array[]

• Splits the binary stream into chunks of the specified number of bytes.

  Parameters

  • bytes: number

    The number of bytes in each chunk.

  Returns Uint8Array[]

  An array of Uint8Array chunks.

toString

• toString(encoding?): string

• Converts the binary stream to a string.

  Parameters

  • Optional encoding: string

    The encoding to use.

  Returns string

  The string representation of the binary stream.

write

• write(buffer, offset?): this

• Writes data to the stream's buffer.

  Parameters

  • buffer: Uint8Array | number[]

    The data to write.
  • Optional offset: number

    The optional offset to write the data at.

  Returns this

  The updated BinaryStream instance.

writeAddress

• writeAddress(address, offset?): this

• Writes an Internet address to the binary stream.

  Parameters

  • address: InternetAddress

    The Internet address to write.
  • Optional offset: number

    The optional offset to write at.

  Returns this

  The updated BinaryStream instance.

writeBigUInt64BE

• writeBigUInt64BE(v, offset?): this

• Writes an unsigned 64-bit big-endian integer to the binary stream.

  Parameters

  • v: bigint

    The value to write.
  • Optional offset: number

    The optional offset at which to write the value.

  Returns this

  The updated BinaryStream instance.

writeBigUInt64LE

• writeBigUInt64LE(v, offset?): this

• Writes an unsigned 64-bit little-endian integer to the binary stream.

  Parameters

  • v: bigint

    The value to write.
  • Optional offset: number

    The optional offset at which to write the value.

  Returns this

  The updated BinaryStream instance.

writeBool

• writeBool(v, offset?): this

• Writes a boolean value.

  Parameters

  • v: boolean

    The boolean value to write.
  • Optional offset: number

    The optional offset to write at.

  Returns this

  The updated BinaryStream instance.

writeFloat32BE

• writeFloat32BE(v, offset?): this

• Writes a 32-bit floating-point number in big-endian format to the binary stream.

  Parameters

  • v: number

    The value to write.
  • Optional offset: number

    The optional offset at which to write the value.

  Returns this

  The updated BinaryStream instance.

writeFloat32LE

• writeFloat32LE(v, offset?): this

• Writes a 32-bit floating-point number in little-endian format to the binary stream.

  Parameters

  • v: number

    The value to write.
  • Optional offset: number

    The optional offset at which to write the value.

  Returns this

  The updated BinaryStream instance.

writeFloat64BE

• writeFloat64BE(v, offset?): this

• Writes an 8-byte floating-point number in big-endian format to the binary stream.

  Parameters

  • v: number

    The value to write.
  • Optional offset: number

    The optional offset at which to write the value.

  Returns this

  The updated BinaryStream instance.

writeFloat64LE

• writeFloat64LE(v, offset?): this

• Writes an 8-byte floating-point number in little-endian format to the binary stream.

  Parameters

  • v: number

    The value to write.
  • Optional offset: number

    The optional offset at which to write the value.

  Returns this

  The updated BinaryStream instance.

writeInt16BE

• writeInt16BE(v, offset?): this

• Writes a 16-bit signed big-endian number.

  Parameters

  • v: number

    The 16-bit signed big-endian number to write.
  • Optional offset: number

    The optional offset to write at.

  Returns this

  The updated BinaryStream instance.

writeInt16LE

• writeInt16LE(v, offset?): this

• Writes a 16-bit signed little-endian number.

  Parameters

  • v: number

    The 16-bit signed little-endian number to write.
  • Optional offset: number

    The optional offset to write at.

  Returns this

  The updated BinaryStream instance.

writeInt32BE

• writeInt32BE(v, offset?): this

• Writes a 32-bit signed big-endian number

  Parameters

  • v: number
  • Optional offset: number

  Returns this

writeInt32LE

• writeInt32LE(v): this

• Writes a 32-bit signed little-endian number

  Parameters

  • v: number

  Returns this

writeInt8

• writeInt8(v, offset?): this

• Writes a signed 8-bit number.

  Parameters

  • v: number

    The signed 8-bit number to write.
  • Optional offset: number

    The optional offset to write at.

  Returns this

  The updated BinaryStream instance.

writeString

• writeString(str, offset?): this

• Writes a string to the buffer

  Parameters

  • str: string
  • Optional offset: number

  Returns this

writeTriadBE

• writeTriadBE(v, offset?): this

• Writes a 3-byte big-endian number.

  Parameters

  • v: number

    The 3-byte big-endian number to write.
  • Optional offset: number

    The optional offset to write at.

  Returns this

  The updated BinaryStream instance.

writeTriadLE

• writeTriadLE(v, offset?): this

• Writes a 3-byte little-endian number.

  Parameters

  • v: number

    The 3-byte little-endian number to write.
  • Optional offset: number

    The optional offset to write at.

  Returns this

  The updated BinaryStream instance.

writeUInt16BE

• writeUInt16BE(v, offset?): this

• Writes a 16-bit unsigned big-endian number.

  Parameters

  • v: number

    The 16-bit unsigned big-endian number to write.
  • Optional offset: number

    The optional offset to write at.

  Returns this

  The updated BinaryStream instance.

writeUInt16LE

• writeUInt16LE(v, offset?): this

• Writes a 16-bit unsigned little-endian number.

  Parameters

  • v: number

    The 16-bit unsigned little-endian number to write.
  • Optional offset: number

    The optional offset to write at.

  Returns this

  The updated BinaryStream instance.

writeUInt32BE

• writeUInt32BE(v, offset?): this

• Writes a 32-bit unsigned big-endian number.

  Parameters

  • v: number

    The 32-bit unsigned big-endian number to write.
  • Optional offset: number

    The optional offset to write at.

  Returns this

  The updated BinaryStream instance.

writeUInt32LE

• writeUInt32LE(v, offset?): this

• Writes a 32-bit unsigned little-endian number

  Parameters

  • v: number
  • Optional offset: number

  Returns this

writeUInt8

• writeUInt8(v, offset?): this

• Writes an unsigned 8-bit number.

  Parameters

  • v: number

    The unsigned 8-bit number to write.
  • Optional offset: number

    The optional offset to write at.

  Returns this

  The updated BinaryStream instance.

writeUVarInt

• writeUVarInt(v, offset?): this

• Writes an unsigned variable-length integer to the binary stream.

  Parameters

  • v: number

    The value to write.
  • Optional offset: number

    The optional offset at which to write the value.

  Returns this

  The updated BinaryStream instance.

writeUVarLong

• writeUVarLong(v, offset?): this

• Writes an unsigned variable-length long integer to the binary stream.

  Parameters

  • v: bigint

    The value to write.
  • Optional offset: number

    The optional offset at which to write the value.

  Returns this

  The updated BinaryStream instance.

writeVarInt

• writeVarInt(v, offset?): this

• Writes a variable-length integer to the binary stream.

  Parameters

  • v: number

    The value to write.
  • Optional offset: number

    The optional offset at which to write the value.

  Returns this

  The updated BinaryStream instance.

writeVarLong

• writeVarLong(v, offset?): this

• Writes a variable-length long integer to the binary stream.

  Parameters

  • v: bigint

    The value to write.
  • Optional offset: number

    The optional offset at which to write the value.

  Returns this

  The updated BinaryStream instance.

Static from

• from(buffer): BinaryStream

• Creates a new BinaryStream from the specified buffer.

  Parameters

  • buffer: ArrayBuffer | Uint8Array | number[]

    The buffer to create the BinaryStream from.

  Returns BinaryStream

  The created BinaryStream instance.
• from(str, encoding): BinaryStream

• Creates a new BinaryStream from the specified string.

  Parameters

  • str: string

    The string to create the BinaryStream from.
  • encoding: "utf8" | "hex" | "binary" | "latin1"

    The encoding to use.

  Returns BinaryStream

  The created BinaryStream instance.