Skip to main content

Class: EnumDescriptorProto

google.protobuf.EnumDescriptorProto

Represents an EnumDescriptorProto.

Implements#

Constructors#

constructor#

new EnumDescriptorProto(properties?)

Constructs a new EnumDescriptorProto.

Parameters#

NameType
properties?IEnumDescriptorProto

Properties#

name#

name: string

EnumDescriptorProto name.

Implementation of#

IEnumDescriptorProto.name


options#

Optional options: null | IEnumOptions

EnumDescriptorProto options.

Implementation of#

IEnumDescriptorProto.options


value#

value: IEnumValueDescriptorProto[]

EnumDescriptorProto value.

Implementation of#

IEnumDescriptorProto.value

Methods#

toJSON#

toJSON(): Object

Converts this EnumDescriptorProto to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): EnumDescriptorProto

Decodes an EnumDescriptorProto message from the specified reader or buffer.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?number-

Returns#

EnumDescriptorProto

EnumDescriptorProto


decodeDelimited#

Static decodeDelimited(reader): EnumDescriptorProto

Decodes an EnumDescriptorProto message from the specified reader or buffer, length delimited.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns#

EnumDescriptorProto

EnumDescriptorProto


encode#

Static encode(message, writer?): Writer

Encodes the specified EnumDescriptorProto message. Does not implicitly {@link google.protobuf.EnumDescriptorProto.verify|verify} messages.

Parameters#

NameTypeDescription
messageIEnumDescriptorProtoEnumDescriptorProto message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

Encodes the specified EnumDescriptorProto message, length delimited. Does not implicitly {@link google.protobuf.EnumDescriptorProto.verify|verify} messages.

Parameters#

NameTypeDescription
messageIEnumDescriptorProtoEnumDescriptorProto message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


fromObject#

Static fromObject(object): EnumDescriptorProto

Creates an EnumDescriptorProto message from a plain object. Also converts values to their respective internal types.

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

EnumDescriptorProto

EnumDescriptorProto


toObject#

Static toObject(message, options?): Object

Creates a plain object from an EnumDescriptorProto message. Also converts values to other types if specified.

Parameters#

NameTypeDescription
messageEnumDescriptorProtoEnumDescriptorProto
options?IConversionOptions-

Returns#

Object

Plain object