Skip to main content

Class: EnumOptions

google.protobuf.EnumOptions

Represents an EnumOptions.

Implements

Constructors

constructor

new EnumOptions(properties?): EnumOptions

Constructs a new EnumOptions.

Parameters

NameTypeDescription
properties?IEnumOptionsProperties to set

Returns

EnumOptions

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


create

create(properties?): EnumOptions

Creates a new EnumOptions instance using the specified properties.

Parameters

NameTypeDescription
properties?IEnumOptionsProperties to set

Returns

EnumOptions

EnumOptions instance


decode

decode(reader, length?): EnumOptions

Decodes an EnumOptions message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

EnumOptions

EnumOptions

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): EnumOptions

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

EnumOptions

EnumOptions

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


encode

encode(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIEnumOptionsEnumOptions message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIEnumOptionsEnumOptions message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

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


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for EnumOptions

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageEnumOptionsEnumOptions
options?IConversionOptionsConversion options

Returns

Object

Plain object