Skip to main content

Class: EnumOptions

google.protobuf.EnumOptions

Represents an EnumOptions.

Implements#

Constructors#

constructor#

new EnumOptions(properties?)

Constructs a new EnumOptions.

Parameters#

NameType
properties?IEnumOptions

Properties#

allowAlias#

allowAlias: boolean

EnumOptions allowAlias.

Implementation of#

IEnumOptions.allowAlias


deprecated#

deprecated: boolean

EnumOptions deprecated.

Implementation of#

IEnumOptions.deprecated


uninterpretedOption#

uninterpretedOption: IUninterpretedOption[]

EnumOptions uninterpretedOption.

Implementation of#

IEnumOptions.uninterpretedOption

Methods#

toJSON#

toJSON(): Object

Converts this EnumOptions to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): EnumOptions

Decodes an EnumOptions 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#

EnumOptions

EnumOptions


decodeDelimited#

Static decodeDelimited(reader): EnumOptions

Decodes an EnumOptions 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#

EnumOptions

EnumOptions


encode#

Static encode(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


fromObject#

Static fromObject(object): EnumOptions

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

EnumOptions

EnumOptions


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageEnumOptionsEnumOptions
options?IConversionOptions-

Returns#

Object

Plain object