Describes a message type.

Generated

from message google.protobuf.DescriptorProto

Hierarchy

Constructors

Properties

Generated

from field: repeated google.protobuf.EnumDescriptorProto enum_type = 4;

Generated

from field: repeated google.protobuf.FieldDescriptorProto extension = 6;

Generated

from field: repeated google.protobuf.DescriptorProto.ExtensionRange extension_range = 5;

Generated

from field: repeated google.protobuf.FieldDescriptorProto field = 2;

name?: string

Generated

from field: optional string name = 1;

nestedType: DescriptorProto[]

Generated

from field: repeated google.protobuf.DescriptorProto nested_type = 3;

Generated

from field: repeated google.protobuf.OneofDescriptorProto oneof_decl = 8;

options?: MessageOptions

Generated

from field: optional google.protobuf.MessageOptions options = 7;

reservedName: string[]

Reserved field names, which may not be used by fields in the same message. A given name may only be reserved once.

Generated

from field: repeated string reserved_name = 10;

Generated

from field: repeated google.protobuf.DescriptorProto.ReservedRange reserved_range = 9;

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

Methods

  • Create a deep copy.

    Returns DescriptorProto

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

  • Parse a message from a JSON string.

    Parameters

    Returns DescriptorProto

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

    Returns MessageType<DescriptorProto>

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

  • Parameters

    Returns DescriptorProto

  • Parameters

    Returns DescriptorProto

Generated using TypeDoc