Skip to main content

Class: EnumReservedRange

protobuf.EnumDescriptorProto.EnumReservedRange

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

Note that this is distinct from DescriptorProto.ReservedRange in that it is inclusive such that it can appropriately represent the entire int32 domain.

Properties​

end​

• end: number

Inclusive.


start​

• start: number

Inclusive.

Methods​

toJSON​

▸ toJSON(): Object

Converts this EnumReservedRange to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): EnumReservedRange & $Properties

Creates a new EnumReservedRange instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

EnumReservedRange & $Properties

EnumReservedRange instance

▸ create(properties?): EnumReservedRange

Parameters​

NameType
properties?$Properties

Returns​

EnumReservedRange


decode​

▸ decode(reader, length?): EnumReservedRange & $Properties

Decodes an EnumReservedRange message from the specified reader or buffer.

Parameters​

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

Returns​

EnumReservedRange & $Properties

EnumReservedRange

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): EnumReservedRange & $Properties

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

EnumReservedRange & $Properties

EnumReservedRange

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 EnumReservedRange message. Does not implicitly google.protobuf.EnumDescriptorProto.EnumReservedRange.verify|verify messages.

Parameters​

NameTypeDescription
message$PropertiesEnumReservedRange message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

NameTypeDescription
message$PropertiesEnumReservedRange message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): EnumReservedRange

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

EnumReservedRange

EnumReservedRange


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageEnumReservedRangeEnumReservedRange
options?IConversionOptionsConversion options

Returns​

Object

Plain object