Class Packet

encoding

ReadonlyinternalBuffer

length

readOffset

writeOffset

clear

• clear(): SmartBuffer

  Clears the SmartBuffer instance to its original empty state.

  Returns SmartBuffer

destroy

• destroy(): SmartBuffer

  Destroys the SmartBuffer instance.

  Returns SmartBuffer

insertBigInt64BE

• insertBigInt64BE(value: bigint, offset: number): SmartBuffer

  Inserts a BigInt64BE value at the given offset value.

  Parameters

  • value: bigint

    { BigInt } The value to insert.

  • offset: number

    { Number } The offset to insert the value at.

  Returns SmartBuffer

  this

insertBigInt64LE

• insertBigInt64LE(value: bigint, offset: number): SmartBuffer

  Inserts a Int64LE value at the given offset value.

  Parameters

  • value: bigint

    { BigInt } The value to insert.

  • offset: number

    { Number } The offset to insert the value at.

  Returns SmartBuffer

  this

insertBigUInt64BE

• insertBigUInt64BE(value: bigint, offset: number): SmartBuffer

  Inserts a BigUInt64BE value at the given offset value.

  Parameters

  • value: bigint

    { Number } The value to insert.

  • offset: number

    { Number } The offset to insert the value at.

  Returns SmartBuffer

  this

insertBigUInt64LE

• insertBigUInt64LE(value: bigint, offset: number): SmartBuffer

  Inserts a BigUInt64LE value at the given offset value.

  Parameters

  • value: bigint

    { Number } The value to insert.

  • offset: number

    { Number } The offset to insert the value at.

  Returns SmartBuffer

  this

insertBuffer

• insertBuffer(value: Buffer, offset: number): SmartBuffer

  Writes a Buffer to the current write position.

  Parameters

  • value: Buffer

    { Buffer } The Buffer to write.

  • offset: number

    { Number } The offset to write the Buffer to.

  Returns SmartBuffer

  this

insertBufferNT

• insertBufferNT(value: Buffer, offset: number): SmartBuffer

  Inserts a null-terminated Buffer.

  Parameters

  • value: Buffer

    { Buffer } The Buffer to write.

  • offset: number

    { Number } The offset to write the Buffer to.

  Returns SmartBuffer

  this

insertDoubleBE

• insertDoubleBE(value: number, offset: number): SmartBuffer

  Inserts a DoubleBE value at the given offset value.

  Parameters

  • value: number

    { Number } The value to insert.

  • offset: number

    { Number } The offset to insert the value at.

  Returns SmartBuffer

  this

insertDoubleLE

• insertDoubleLE(value: number, offset: number): SmartBuffer

  Inserts a DoubleLE value at the given offset value.

  Parameters

  • value: number

    { Number } The value to insert.

  • offset: number

    { Number } The offset to insert the value at.

  Returns SmartBuffer

  this

insertFloatBE

• insertFloatBE(value: number, offset: number): SmartBuffer

  Inserts a FloatBE value at the given offset value.

  Parameters

  • value: number

    { Number } The value to insert.

  • offset: number

    { Number } The offset to insert the value at.

  Returns SmartBuffer

  this

insertFloatLE

• insertFloatLE(value: number, offset: number): SmartBuffer

  Inserts a FloatLE value at the given offset value.

  Parameters

  • value: number

    { Number } The value to insert.

  • offset: number

    { Number } The offset to insert the value at.

  Returns SmartBuffer

  this

insertInt16BE

• insertInt16BE(value: number, offset: number): SmartBuffer

  Inserts an Int16BE value at the given offset value.

  Parameters

  • value: number

    { Number } The value to insert.

  • offset: number

    { Number } The offset to insert the value at.

  Returns SmartBuffer

  this

insertInt16LE

• insertInt16LE(value: number, offset: number): SmartBuffer

  Inserts an Int16LE value at the given offset value.

  Parameters

  • value: number

    { Number } The value to insert.

  • offset: number

    { Number } The offset to insert the value at.

  Returns SmartBuffer

  this

insertInt32BE

• insertInt32BE(value: number, offset: number): SmartBuffer

  Inserts an Int32BE value at the given offset value.

  Parameters

  • value: number

    { Number } The value to insert.

  • offset: number

    { Number } The offset to insert the value at.

  Returns SmartBuffer

  this

insertInt32LE

• insertInt32LE(value: number, offset: number): SmartBuffer

  Inserts an Int32LE value at the given offset value.

  Parameters

  • value: number

    { Number } The value to insert.

  • offset: number

    { Number } The offset to insert the value at.

  Returns SmartBuffer

  this

insertInt8

• insertInt8(value: number, offset: number): SmartBuffer

  Inserts an Int8 value at the given offset value.

  Parameters

  • value: number

    { Number } The value to insert.

  • offset: number

    { Number } The offset to insert the value at.

  Returns SmartBuffer

  this

insertString

• insertString(
      value: string,
      offset: number,
      encoding?: BufferEncoding,
  ): SmartBuffer

  Inserts a String

  Parameters

  • value: string

    { String } The String value to insert.

  • offset: number

    { Number } The offset to insert the string at.

  • Optionalencoding: BufferEncoding

    { String } The BufferEncoding to use for writing strings (defaults to instance encoding).

  Returns SmartBuffer

  this

insertStringNT

• insertStringNT(
      value: string,
      offset: number,
      encoding?: BufferEncoding,
  ): SmartBuffer

  Inserts a null-terminated String.

  Parameters

  • value: string

    { String } The String value to write.

  • offset: number
  • Optionalencoding: BufferEncoding

    { String } The BufferEncoding to use for writing strings (defaults to instance encoding).

  Returns SmartBuffer

  this

insertUInt16BE

• insertUInt16BE(value: number, offset: number): SmartBuffer

  Inserts an UInt16BE value at the given offset value.

  Parameters

  • value: number

    { Number } The value to insert.

  • offset: number

    { Number } The offset to insert the value at.

  Returns SmartBuffer

  this

insertUInt16LE

• insertUInt16LE(value: number, offset: number): SmartBuffer

  Inserts an UInt16LE value at the given offset value.

  Parameters

  • value: number

    { Number } The value to insert.

  • offset: number

    { Number } The offset to insert the value at.

  Returns SmartBuffer

  this

insertUInt32BE

• insertUInt32BE(value: number, offset: number): SmartBuffer

  Inserts an UInt32BE value at the given offset value.

  Parameters

  • value: number

    { Number } The value to insert.

  • offset: number

    { Number } The offset to insert the value at.

  Returns SmartBuffer

  this

insertUInt32LE

• insertUInt32LE(value: number, offset: number): SmartBuffer

  Inserts an UInt32LE value at the given offset value.

  Parameters

  • value: number

    { Number } The value to insert.

  • offset: number

    { Number } The offset to insert the value at.

  Returns SmartBuffer

  this

insertUInt8

• insertUInt8(value: number, offset: number): SmartBuffer

  Inserts an UInt8 value at the given offset value.

  Parameters

  • value: number

    { Number } The value to insert.

  • offset: number

    { Number } The offset to insert the value at.

  Returns SmartBuffer

  this

readBigInt64BE

• readBigInt64BE(offset?: number): bigint

  Reads a BigInt64BE value from the current read position or an optionally provided offset.

  Parameters

  • Optionaloffset: number

    { Number } The offset to read data from (optional)

  Returns bigint

readBigInt64LE

• readBigInt64LE(offset?: number): bigint

  Reads a BigInt64LE value from the current read position or an optionally provided offset.

  Parameters

  • Optionaloffset: number

    { Number } The offset to read data from (optional)

  Returns bigint

readBigUInt64BE

• readBigUInt64BE(offset?: number): bigint

  Reads a BigUInt64BE value from the current read position or an optionally provided offset.

  Parameters

  • Optionaloffset: number

    { Number } The offset to read data from (optional)

  Returns bigint

readBigUInt64LE

• readBigUInt64LE(offset?: number): bigint

  Reads a BigUInt64LE value from the current read position or an optionally provided offset.

  Parameters

  • Optionaloffset: number

    { Number } The offset to read data from (optional)

  Returns bigint

readBuffer

• readBuffer(length?: number): Buffer

  Reads a Buffer from the internal read position.

  Parameters

  • Optionallength: number

    { Number } The length of data to read as a Buffer.

  Returns Buffer

readBufferNT

• readBufferNT(): Buffer

  Reads a null-terminated Buffer from the current read poisiton.

  Returns Buffer

readDoubleBE

• readDoubleBE(offset?: number): number

  Reads an DoublEBE value from the current read position or an optionally provided offset.

  Parameters

  • Optionaloffset: number

    { Number } The offset to read data from (optional)

  Returns number

readDoubleLE

• readDoubleLE(offset?: number): number

  Reads an DoubleLE value from the current read position or an optionally provided offset.

  Parameters

  • Optionaloffset: number

    { Number } The offset to read data from (optional)

  Returns number

readFloatBE

• readFloatBE(offset?: number): number

  Reads an FloatBE value from the current read position or an optionally provided offset.

  Parameters

  • Optionaloffset: number

    { Number } The offset to read data from (optional)

  Returns number

readFloatLE

• readFloatLE(offset?: number): number

  Reads an FloatLE value from the current read position or an optionally provided offset.

  Parameters

  • Optionaloffset: number

    { Number } The offset to read data from (optional)

  Returns number

readInt16BE

• readInt16BE(offset?: number): number

  Reads an Int16BE value from the current read position or an optionally provided offset.

  Parameters

  • Optionaloffset: number

    { Number } The offset to read data from (optional)

  Returns number

readInt16LE

• readInt16LE(offset?: number): number

  Reads an Int16LE value from the current read position or an optionally provided offset.

  Parameters

  • Optionaloffset: number

    { Number } The offset to read data from (optional)

  Returns number

readInt32BE

• readInt32BE(offset?: number): number

  Reads an Int32BE value from the current read position or an optionally provided offset.

  Parameters

  • Optionaloffset: number

    { Number } The offset to read data from (optional)

  Returns number

readInt32LE

• readInt32LE(offset?: number): number

  Reads an Int32LE value from the current read position or an optionally provided offset.

  Parameters

  • Optionaloffset: number

    { Number } The offset to read data from (optional)

  Returns number

readInt8

• readInt8(offset?: number): number

  Reads an Int8 value from the current read position or an optionally provided offset.

  Parameters

  • Optionaloffset: number

    { Number } The offset to read data from (optional)

  Returns number

readString

• readString(arg1?: number | BufferEncoding, encoding?: BufferEncoding): string

  Reads a String from the current read position.

  Parameters

  • Optionalarg1: number | BufferEncoding

    { Number | String } The number of bytes to read as a String, or the BufferEncoding to use for the string (Defaults to instance level encoding).

  • Optionalencoding: BufferEncoding

    { String } The BufferEncoding to use for the string (Defaults to instance level encoding).

  Returns string

readStringNT

• readStringNT(encoding?: BufferEncoding): string

  Reads a null-terminated String from the current read position.

  Parameters

  • Optionalencoding: BufferEncoding

    { String } The BufferEncoding to use for the string (Defaults to instance level encoding).

  Returns string

readUInt16BE

• readUInt16BE(offset?: number): number

  Reads an UInt16BE value from the current read position or an optionally provided offset.

  Parameters

  • Optionaloffset: number

    { Number } The offset to read data from (optional)

  Returns number

readUInt16LE

• readUInt16LE(offset?: number): number

  Reads an UInt16LE value from the current read position or an optionally provided offset.

  Parameters

  • Optionaloffset: number

    { Number } The offset to read data from (optional)

  Returns number

readUInt32BE

• readUInt32BE(offset?: number): number

  Reads an UInt32BE value from the current read position or an optionally provided offset.

  Parameters

  • Optionaloffset: number

    { Number } The offset to read data from (optional)

  Returns number

readUInt32LE

• readUInt32LE(offset?: number): number

  Reads an UInt32LE value from the current read position or an optionally provided offset.

  Parameters

  • Optionaloffset: number

    { Number } The offset to read data from (optional)

  Returns number

readUInt8

• readUInt8(offset?: number): number

  Reads an UInt8 value from the current read position or an optionally provided offset.

  Parameters

  • Optionaloffset: number

    { Number } The offset to read data from (optional)

  Returns number

remaining

• remaining(): number

  Gets the remaining data left to be read from the SmartBuffer instance.

  Returns number

toBuffer

• toBuffer(): Buffer

  Gets the value of the internal managed Buffer (Includes managed data only)

  Returns Buffer

toString

• toString(encoding?: BufferEncoding): string

  Gets the String value of the internal managed Buffer

  Parameters

  • Optionalencoding: BufferEncoding

    { String } The BufferEncoding to display the Buffer as (defaults to instance level encoding).

  Returns string

writeBigInt64BE

• writeBigInt64BE(value: bigint, offset?: number): SmartBuffer

  Writes a BigInt64BE value to the current write position (or at optional offset).

  Parameters

  • value: bigint

    { BigInt } The value to write.

  • Optionaloffset: number

    { Number } The offset to write the value at.

  Returns SmartBuffer

  this

writeBigInt64LE

• writeBigInt64LE(value: bigint, offset?: number): SmartBuffer

  Writes a BigInt64LE value to the current write position (or at optional offset).

  Parameters

  • value: bigint

    { BigInt } The value to write.

  • Optionaloffset: number

    { Number } The offset to write the value at.

  Returns SmartBuffer

  this

writeBigUInt64BE

• writeBigUInt64BE(value: bigint, offset?: number): SmartBuffer

  Writes a BigUInt64BE value to the current write position (or at optional offset).

  Parameters

  • value: bigint

    { Number } The value to write.

  • Optionaloffset: number

    { Number } The offset to write the value at.

  Returns SmartBuffer

  this

writeBigUInt64LE

• writeBigUInt64LE(value: bigint, offset?: number): SmartBuffer

  Writes a BigUInt64LE value to the current write position (or at optional offset).

  Parameters

  • value: bigint

    { Number } The value to write.

  • Optionaloffset: number

    { Number } The offset to write the value at.

  Returns SmartBuffer

  this

writeBuffer

• writeBuffer(value: Buffer, offset?: number): SmartBuffer

  Writes a Buffer to the current write position.

  Parameters

  • value: Buffer

    { Buffer } The Buffer to write.

  • Optionaloffset: number

    { Number } The offset to write the Buffer to.

  Returns SmartBuffer

  this

writeBufferNT

• writeBufferNT(value: Buffer, offset?: number): SmartBuffer

  Writes a null-terminated Buffer.

  Parameters

  • value: Buffer

    { Buffer } The Buffer to write.

  • Optionaloffset: number

    { Number } The offset to write the Buffer to.

  Returns SmartBuffer

  this

writeDoubleBE

• writeDoubleBE(value: number, offset?: number): SmartBuffer

  Writes a DoubleBE value to the current write position (or at optional offset).

  Parameters

  • value: number

    { Number } The value to write.

  • Optionaloffset: number

    { Number } The offset to write the value at.

  Returns SmartBuffer

  this

writeDoubleLE

• writeDoubleLE(value: number, offset?: number): SmartBuffer

  Writes a DoubleLE value to the current write position (or at optional offset).

  Parameters

  • value: number

    { Number } The value to write.

  • Optionaloffset: number

    { Number } The offset to write the value at.

  Returns SmartBuffer

  this

writeFloatBE

• writeFloatBE(value: number, offset?: number): SmartBuffer

  Writes a FloatBE value to the current write position (or at optional offset).

  Parameters

  • value: number

    { Number } The value to write.

  • Optionaloffset: number

    { Number } The offset to write the value at.

  Returns SmartBuffer

  this

writeFloatLE

• writeFloatLE(value: number, offset?: number): SmartBuffer

  Writes a FloatLE value to the current write position (or at optional offset).

  Parameters

  • value: number

    { Number } The value to write.

  • Optionaloffset: number

    { Number } The offset to write the value at.

  Returns SmartBuffer

  this

writeInt16BE

• writeInt16BE(value: number, offset?: number): SmartBuffer

  Writes an Int16BE value to the current write position (or at optional offset).

  Parameters

  • value: number

    { Number } The value to write.

  • Optionaloffset: number

    { Number } The offset to write the value at.

  Returns SmartBuffer

  this

writeInt16LE

• writeInt16LE(value: number, offset?: number): SmartBuffer

  Writes an Int16LE value to the current write position (or at optional offset).

  Parameters

  • value: number

    { Number } The value to write.

  • Optionaloffset: number

    { Number } The offset to write the value at.

  Returns SmartBuffer

  this

writeInt32BE

• writeInt32BE(value: number, offset?: number): SmartBuffer

  Writes an Int32BE value to the current write position (or at optional offset).

  Parameters

  • value: number

    { Number } The value to write.

  • Optionaloffset: number

    { Number } The offset to write the value at.

  Returns SmartBuffer

  this

writeInt32LE

• writeInt32LE(value: number, offset?: number): SmartBuffer

  Writes an Int32LE value to the current write position (or at optional offset).

  Parameters

  • value: number

    { Number } The value to write.

  • Optionaloffset: number

    { Number } The offset to write the value at.

  Returns SmartBuffer

  this

writeInt8

• writeInt8(value: number, offset?: number): SmartBuffer

  Writes an Int8 value to the current write position (or at optional offset).

  Parameters

  • value: number

    { Number } The value to write.

  • Optionaloffset: number

    { Number } The offset to write the value at.

  Returns SmartBuffer

  this

writeString

• writeString(
      value: string,
      arg2?: number | BufferEncoding,
      encoding?: BufferEncoding,
  ): SmartBuffer

  Writes a String

  Parameters

  • value: string

    { String } The String value to write.

  • Optionalarg2: number | BufferEncoding

    { Number | String } The offset to write the string at, or the BufferEncoding to use.

  • Optionalencoding: BufferEncoding

    { String } The BufferEncoding to use for writing strings (defaults to instance encoding).

  Returns SmartBuffer

  this

writeStringNT

• writeStringNT(
      value: string,
      arg2?: number | BufferEncoding,
      encoding?: BufferEncoding,
  ): SmartBuffer

  Writes a null-terminated String.

  Parameters

  • value: string

    { String } The String value to write.

  • Optionalarg2: number | BufferEncoding

    { Number | String } The offset to write the string to, or the BufferEncoding to use.

  • Optionalencoding: BufferEncoding

    { String } The BufferEncoding to use for writing strings (defaults to instance encoding).

  Returns SmartBuffer

  this

writeUInt16BE

• writeUInt16BE(value: number, offset?: number): SmartBuffer

  Writes an UInt16BE value to the current write position (or at optional offset).

  Parameters

  • value: number

    { Number } The value to write.

  • Optionaloffset: number

    { Number } The offset to write the value at.

  Returns SmartBuffer

  this

writeUInt16LE

• writeUInt16LE(value: number, offset?: number): SmartBuffer

  Writes an UInt16LE value to the current write position (or at optional offset).

  Parameters

  • value: number

    { Number } The value to write.

  • Optionaloffset: number

    { Number } The offset to write the value at.

  Returns SmartBuffer

  this

writeUInt32BE

• writeUInt32BE(value: number, offset?: number): SmartBuffer

  Writes an UInt32BE value to the current write position (or at optional offset).

  Parameters

  • value: number

    { Number } The value to write.

  • Optionaloffset: number

    { Number } The offset to write the value at.

  Returns SmartBuffer

  this

writeUInt32LE

• writeUInt32LE(value: number, offset?: number): SmartBuffer

  Writes an UInt32LE value to the current write position (or at optional offset).

  Parameters

  • value: number

    { Number } The value to write.

  • Optionaloffset: number

    { Number } The offset to write the value at.

  Returns SmartBuffer

  this

writeUInt8

• writeUInt8(value: number, offset?: number): SmartBuffer

  Writes an UInt8 value to the current write position (or at optional offset).

  Parameters

  • value: number

    { Number } The value to write.

  • Optionaloffset: number

    { Number } The offset to write the value at.

  Returns SmartBuffer

  this

StaticfromBuffer

• fromBuffer(buff: Buffer, encoding?: BufferEncoding): SmartBuffer

  Creates a new SmartBuffer instance with the provided Buffer and optional encoding.

  Parameters

  • buff: Buffer
  • Optionalencoding: BufferEncoding

    { String } The BufferEncoding to use for strings.

  Returns SmartBuffer

StaticfromOptions

• fromOptions(options: SmartBufferOptions): SmartBuffer

  Creates a new SmartBuffer instance with the provided SmartBufferOptions options.

  Parameters

  • options: SmartBufferOptions

    { SmartBufferOptions } The options to use when creating the SmartBuffer instance.

  Returns SmartBuffer

StaticfromSize

• fromSize(size: number, encoding?: BufferEncoding): SmartBuffer

  Creates a new SmartBuffer instance with the provided internal Buffer size and optional encoding.

  Parameters

  • size: number

    { Number } The size of the internal Buffer.

  • Optionalencoding: BufferEncoding

    { String } The BufferEncoding to use for strings.

  Returns SmartBuffer

StaticisSmartBufferOptions

• isSmartBufferOptions(options: SmartBufferOptions): options is SmartBufferOptions

  Type checking function that determines if an object is a SmartBufferOptions object.

  Parameters

  • options: SmartBufferOptions

  Returns options is SmartBufferOptions