A protocol buffer message type.

Generated

from message google.protobuf.Type

Hierarchy

Constructors

  • Parameters

    Returns Type

Properties

fields: Field[]

The list of fields.

Generated

from field: repeated google.protobuf.Field fields = 2;

name: string

The fully qualified message name.

Generated

from field: string name = 1;

oneofs: string[]

The list of types appearing in oneof definitions in this type.

Generated

from field: repeated string oneofs = 3;

options: Option[]

The protocol buffer options.

Generated

from field: repeated google.protobuf.Option options = 4;

sourceContext?: SourceContext

The source context.

Generated

from field: google.protobuf.SourceContext source_context = 5;

syntax: Syntax

The source syntax.

Generated

from field: google.protobuf.Syntax syntax = 6;

fields: FieldList
runtime: ProtoRuntime
typeName: "google.protobuf.Type" = "google.protobuf.Type"

Methods

  • Create a deep copy.

    Returns Type

  • 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 Type

  • Parse a message from a JSON value.

    Parameters

    Returns Type

  • Parse a message from a JSON string.

    Parameters

    Returns Type

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

    Returns MessageType<Type>

  • 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

  • Parameters

    Returns boolean

  • Parameters

    Returns Type

  • Parameters

    Returns Type

  • Parameters

    Returns Type

Generated using TypeDoc