AnyMessage is an interface implemented by all messages. If you need to handle messages of unknown type, this interface provides a convenient index signature to access fields with message["fieldname"].

interface AnyMessage {
    clone(): AnyMessage;
    equals(other): boolean;
    fromBinary(bytes, options?): this;
    fromJson(jsonValue, options?): this;
    fromJsonString(jsonString, options?): this;
    getType(): MessageType<AnyMessage>;
    toBinary(options?): Uint8Array;
    toJSON(): JsonValue;
    toJson(options?): JsonValue;
    toJsonString(options?): string;
    [k: string]: any;
}

Hierarchy (view full)

Indexable

[k: string]: any

Methods

  • Create a deep copy.

    Returns AnyMessage

  • Compare with a message of the same type.

    Parameters

    Returns boolean

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting existing keys.

    If a message field is already present, it will be merged with the new data.

    Parameters

    Returns this

  • Parse a message from a JSON value.

    Parameters

    Returns this

  • Parse a message from a JSON string.

    Parameters

    Returns this

  • Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.

    Returns MessageType<AnyMessage>

  • Serialize the message to binary data.

    Parameters

    Returns Uint8Array

  • Override for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).

    Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.

    This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.

    Returns JsonValue

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    Returns JsonValue

  • Serialize the message to a JSON string.

    Parameters

    Returns string

Generated using TypeDoc