Variable protoDelimitedConst

Type declaration

• dec:function

  • dec<T>(type, bytes, options?): T

  • Parse a size-delimited message, ignoring extra bytes.

    Type Parameters

    • T extends Message<T>

    Parameters

    • type: MessageType<T>

    • bytes: Uint8Array

    • Optional options: BinaryReadOptions

    Returns T

• decStream:function

  • decStream<T_1>(type, iterable): AsyncGenerator<T_1, void, unknown>

  • Parse a stream of size-delimited messages.

    Type Parameters

    • T_1 extends Message<T_1>

    Parameters

    • type: MessageType<T_1>

    • iterable: AsyncIterable<Uint8Array>

    Returns AsyncGenerator<T_1, void, unknown>

• enc:function

  • enc(message, options?): Uint8Array

  • Serialize a message, prefixing it with its size.

    Parameters

    • message: Message<AnyMessage>

    • Optional options: BinaryWriteOptions

    Returns Uint8Array

• peekSize:function

  • peekSize(data): {
        eof: false;
        offset: number;
        size: number;
    } | {
        eof: true;
        offset: null;
        size: null;
    }

  • Decodes the size from the given size-delimited message, which may be incomplete.

    Returns an object with the following properties:

    • size: The size of the delimited message in bytes
    • offset: The offset in the given byte array where the message starts
    • eof: true

    If the size-delimited data does not include all bytes of the varint size, the following object is returned:

    • size: null
    • offset: null
    • eof: false

    This function can be used to implement parsing of size-delimited messages from a stream.

    Parameters

    • data: Uint8Array

    Returns {
        eof: false;
        offset: number;
        size: number;
    } | {
        eof: true;
        offset: null;
        size: null;
    }