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.
Implements
Constructors
constructor
• new EnumReservedRange(properties?
): EnumReservedRange
Constructs a new EnumReservedRange.
Parameters
Name | Type | Description |
---|---|---|
properties? | IEnumReservedRange | Properties to set |
Returns
Properties
end
• end: number
Inclusive.
Implementation of
start
• start: number
Inclusive.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this EnumReservedRange to JSON.
Returns
Object
JSON object
create
▸ create(properties?
): EnumReservedRange
Creates a new EnumReservedRange instance using the specified properties.
Parameters
Name | Type | Description |
---|---|---|
properties? | IEnumReservedRange | Properties to set |
Returns
EnumReservedRange instance
decode
▸ decode(reader
, length?
): EnumReservedRange
Decodes an EnumReservedRange message from the specified reader or buffer.
Parameters
Name | Type | Description |
---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
EnumReservedRange
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader
): EnumReservedRange
Decodes an EnumReservedRange message from the specified reader or buffer, length delimited.
Parameters
Name | Type | Description |
---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
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
Name | Type | Description |
---|---|---|
message | IEnumReservedRange | EnumReservedRange message or plain object to encode |
writer? | Writer | Writer 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
Name | Type | Description |
---|---|---|
message | IEnumReservedRange | EnumReservedRange message or plain object to encode |
writer? | Writer | Writer 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
Name | Type | Description |
---|---|---|
object | Object | Plain object |
Returns
EnumReservedRange
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?
): string
Gets the default type url for EnumReservedRange
Parameters
Name | Type | Description |
---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message
, options?
): Object
Creates a plain object from an EnumReservedRange message. Also converts values to other types if specified.
Parameters
Name | Type | Description |
---|---|---|
message | EnumReservedRange | EnumReservedRange |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object