Interface DescEnumValue

Describes an individual value of an enumeration in a protobuf source file.

interface DescEnumValue {
    deprecated: boolean;
    kind: "enum_value";
    name: string;
    number: number;
    parent: DescEnum;
    proto: EnumValueDescriptorProto;
    declarationString(): string;
    getComments(): DescComments;
    getFeatures(): MergedFeatureSet;
    toString(): string;
}

Properties

deprecated kind name number parent proto

Methods

declarationString getComments getFeatures toString

Properties

Readonly deprecated

deprecated: boolean

Marked as deprecated in the protobuf source.

kind

kind: "enum_value"

Readonly name

name: string

The name of the enumeration value, as specified in the protobuf source.

Readonly number

number: number

The numeric enumeration value, as specified in the protobuf source.

Readonly parent

parent: DescEnum

The enumeration this value belongs to.

Readonly proto

proto: EnumValueDescriptorProto

The compiler-generated descriptor.

Methods

declarationString

  • declarationString(): string

  • Return a string that (closely) matches the definition of the enumeration value in the protobuf source.

    Returns string

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

deprecatedkindnamenumberparentprotodeclarationStringgetCommentsgetFeaturestoString