Skip to main content

Class: EnumDescriptorProto

Describes an enum type.

Properties​

name​

name: string

EnumDescriptorProto name.

options?​

optional options?: $Properties | null

EnumDescriptorProto options.

reservedName​

reservedName: string[]

Reserved enum value names, which may not be reused. A given name may only be reserved once.

reservedRange​

reservedRange: $Properties[]

Range of reserved numeric values. Reserved numeric values may not be used by enum values in the same enum declaration. Reserved ranges may not overlap.

value​

value: $Properties[]

EnumDescriptorProto value.

Methods​

toJSON()​

toJSON(): object

Converts this EnumDescriptorProto to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): EnumDescriptorProto & $Shape

Creates a new EnumDescriptorProto instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

EnumDescriptorProto & $Shape

EnumDescriptorProto instance

Call Signature​

static create(properties?): EnumDescriptorProto

Creates a new EnumDescriptorProto instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

EnumDescriptorProto

EnumDescriptorProto instance

decode()​

static decode(reader, length?): EnumDescriptorProto & $Shape

Decodes an EnumDescriptorProto message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

EnumDescriptorProto & $Shape

EnumDescriptorProto

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): EnumDescriptorProto & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

EnumDescriptorProto & $Shape

EnumDescriptorProto

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified EnumDescriptorProto message. Does not implicitly google.protobuf.EnumDescriptorProto.verify|verify messages.

Parameters​

message​

$Properties

EnumDescriptorProto message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

EnumDescriptorProto message or plain object to encode

writer?​

Writer

Writer to encode to

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​

object​

{[k: string]: any; }

Plain 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​

message​

EnumDescriptorProto

EnumDescriptorProto

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object