Skip to main content

Class: 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()​

Call Signature​

static create(properties?): EnumReservedRange & $Properties

Creates a new EnumReservedRange instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

EnumReservedRange & $Properties

EnumReservedRange instance

Call Signature​

static create(properties?): EnumReservedRange

Creates a new EnumReservedRange instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

EnumReservedRange

EnumReservedRange instance


decode()​

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

Decodes an EnumReservedRange 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​

EnumReservedRange & $Properties

EnumReservedRange

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing


decodeDelimited()​

static decodeDelimited(reader): EnumReservedRange & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader 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()​

static encode(message, writer?): Writer

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

Parameters​

message​

$Properties

EnumReservedRange message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

EnumReservedRange message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


fromObject()​

static fromObject(object): EnumReservedRange

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

EnumReservedRange

EnumReservedRange


toObject()​

static toObject(message, options?): object

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

Parameters​

message​

EnumReservedRange

EnumReservedRange

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object