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

    Type Alias FrameResult

    FrameResult:
        | { bytesConsumed: number; packetData: Uint8Array; status: "complete" }
        | { status: "incomplete" }
        | { error: ReturnType<typeof decodeError>; status: "error" }

    Result of attempting to read a packet frame from the buffer.

    Type Declaration

    • { bytesConsumed: number; packetData: Uint8Array; status: "complete" }
      • bytesConsumed: number

        Number of bytes consumed from the buffer.

      • packetData: Uint8Array

        The complete packet data.

      • status: "complete"

        Frame was successfully extracted.

    • { status: "incomplete" }
      • status: "incomplete"

        More data needed to complete the frame.

    • { error: ReturnType<typeof decodeError>; status: "error" }
      • error: ReturnType<typeof decodeError>

        The decode error with details.

      • status: "error"

        Frame parsing failed with an error.