Interface DescMessage

Describes a message declaration in a protobuf source file.

interface DescMessage {
    deprecated: boolean;
    fields: DescField[];
    file: DescFile;
    kind: "message";
    members: (DescField | DescOneof)[];
    name: string;
    nestedEnums: DescEnum[];
    nestedExtensions: DescExtension[];
    nestedMessages: DescMessage[];
    oneofs: DescOneof[];
    parent: DescMessage;
    proto: DescriptorProto;
    typeName: string;
    getComments(): DescComments;
    getFeatures(): MergedFeatureSet;
    toString(): string;
}

Properties

deprecated fields file kind members name nestedEnums nestedExtensions nestedMessages oneofs parent proto typeName

Methods

getComments getFeatures toString

Properties

Readonly deprecated

deprecated: boolean

Marked as deprecated in the protobuf source.

Readonly fields

fields: DescField[]

Fields declared for this message, including fields declared in a oneof group.

Readonly file

file: DescFile

The file this message was declared in.

Readonly kind

kind: "message"

Readonly members

members: (DescField | DescOneof)[]

Fields and oneof groups for this message, ordered by their appearance in the protobuf source.

Readonly name

name: string

The name of the message, as specified in the protobuf source.

Readonly nestedEnums

nestedEnums: DescEnum[]

Enumerations declared within the message, if any.

Readonly nestedExtensions

nestedExtensions: DescExtension[]

Extensions declared within the message, if any.

Readonly nestedMessages

nestedMessages: DescMessage[]

Messages declared within the message, if any. This does not include synthetic messages like map entries.

Readonly oneofs

oneofs: DescOneof[]

Oneof groups declared for this message. This does not include synthetic oneofs for proto3 optionals.

Readonly parent

parent: DescMessage

The parent message, if this message was declared inside a message declaration.

Readonly proto

proto: DescriptorProto

The compiler-generated descriptor.

Readonly typeName

typeName: string

The fully qualified name of the message. (We omit the leading dot.)

Methods

getComments

  • getComments(): DescComments

  • Get comments on the element in the protobuf source.

    Returns DescComments

getFeatures

  • getFeatures(): MergedFeatureSet

  • Get the edition features for this protobuf element.

    Returns MergedFeatureSet

toString

  • toString(): string

  • Returns string

Settings

Member Visibility

Theme

On This Page

deprecatedfieldsfilekindmembersnamenestedEnumsnestedExtensionsnestedMessagesoneofsparentprototypeNamegetCommentsgetFeaturestoString