Interface DescEnum

Describes an enumeration in a protobuf source file.

Hierarchy

  • DescEnum

Properties

deprecated file kind name parent proto sharedPrefix? typeName values

Methods

getComments toString

Properties

Readonly deprecated

deprecated: boolean

Marked as deprecated in the protobuf source.

Readonly file

file: DescFile

The file this enumeration was declared in.

kind

kind: "enum"

Readonly name

name: string

The name of the enumeration, as declared in the protobuf source.

Readonly parent

parent: undefined | DescMessage

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

Readonly proto

proto: EnumDescriptorProto

The compiler-generated descriptor.

Optional Readonly sharedPrefix

sharedPrefix?: string

A prefix shared by all enum values. For example, MY_ENUM_ for enum MyEnum {MY_ENUM_A=0; MY_ENUM_B=1;}

Readonly typeName

typeName: string

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

Readonly values

values: DescEnumValue[]

Values declared for this enumeration.

Methods

getComments

  • Get comments on the element in the protobuf source.

    Returns DescComments

toString

  • Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc