@qualithm/mqtt-wire - v0.1.5
    Preparing search index...

    Class BinaryWriter

    A binary writer with automatic buffer growth.

    The writer maintains a position cursor and automatically grows the internal buffer as needed. Use toUint8Array to get the final bytes.

    const writer = new BinaryWriter()
    writer
    .writeUint8(0x10)
    .writeVariableByteInteger(12)
    .writeMqttString("MQTT")

    const bytes = writer.toUint8Array()
    Index

    Constructors

    • Creates a new binary writer.

      Parameters

      • initialSize: number = DEFAULT_INITIAL_SIZE

        Initial buffer size (default: 256)

      Returns BinaryWriter

    Accessors

    • get length(): number

      Gets the current write position (number of bytes written).

      Returns number

    Methods

    • Reserves space for bytes to be written later.

      Returns the offset where the reserved space starts.

      Parameters

      • count: number

        Number of bytes to reserve

      Returns number

      The offset where reserved space starts

    • Gets the final bytes as a new Uint8Array.

      Returns a trimmed copy of the internal buffer.

      Returns Uint8Array

    • Gets a view of the written data.

      Returns a view into the internal buffer (no copy). The view is only valid until the next write operation.

      Returns Uint8Array

    • Writes bytes at a specific offset (for filling reserved space).

      Does not advance the write position.

      Parameters

      • offset: number

        The offset to write at

      • bytes: Uint8Array

        The bytes to write

      Returns void

    • Writes raw bytes.

      Parameters

      • bytes: Uint8Array

      Returns this

    • Writes binary data with MQTT length prefix.

      Parameters

      • data: Uint8Array

      Returns this

    • Writes a UTF-8 string with MQTT length prefix.

      Parameters

      • str: string

      Returns this

      MQTT 5.0 §1.5.4

    • Writes an unsigned 16-bit integer (big-endian).

      Parameters

      • value: number

      Returns this

    • Writes an unsigned 32-bit integer (big-endian).

      Parameters

      • value: number

      Returns this

    • Writes a single unsigned 8-bit integer.

      Parameters

      • value: number

      Returns this

    • Writes a single byte at a specific offset.

      Parameters

      • offset: number

        The offset to write at

      • value: number

        The byte value to write

      Returns void

    • Writes a raw UTF-8 string without length prefix.

      Parameters

      • str: string

      Returns this

    • Writes a variable byte integer.

      Parameters

      • value: number

      Returns this

      MQTT 5.0 §2.2.3