Interface DescOneof

Describes a oneof group in a protobuf source file.

interface DescOneof {
    deprecated: boolean;
    fields: DescField[];
    kind: "oneof";
    name: string;
    parent: DescMessage;
    proto: OneofDescriptorProto;
    getComments(): DescComments;
    getFeatures(): MergedFeatureSet;
    toString(): string;
}

Properties

deprecated fields kind name parent proto

Methods

getComments getFeatures toString

Properties

Readonly deprecated

deprecated: boolean

Marked as deprecated in the protobuf source. Note that oneof groups cannot be marked as deprecated, this property only exists for consistency and will always be false.

Readonly fields

fields: DescField[]

The fields declared in this oneof group.

Readonly kind

kind: "oneof"

Readonly name

name: string

The name of the oneof group, as specified in the protobuf source.

Readonly parent

parent: DescMessage

The message this oneof group was declared in.

Readonly proto

proto: OneofDescriptorProto

The compiler-generated descriptor.

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

deprecatedfieldskindnameparentprotogetCommentsgetFeaturestoString