Class: EnumValueDescriptorProto
google.protobuf.EnumValueDescriptorProto
Represents an EnumValueDescriptorProto.
Implements
Constructors
constructor
• new EnumValueDescriptorProto(properties?): EnumValueDescriptorProto
Constructs a new EnumValueDescriptorProto.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IEnumValueDescriptorProto | Properties to set |
Returns
Properties
name
• name: string
EnumValueDescriptorProto name.
Implementation of
IEnumValueDescriptorProto.name
number
• number: number
EnumValueDescriptorProto number.
Implementation of
IEnumValueDescriptorProto.number
options
• Optional options: null | IEnumValueOptions
EnumValueDescriptorProto options.
Implementation of
IEnumValueDescriptorProto.options
Methods
toJSON
▸ toJSON(): Object
Converts this EnumValueDescriptorProto to JSON.
Returns
Object
JSON object
create
▸ create(properties?): EnumValueDescriptorProto
Creates a new EnumValueDescriptorProto instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IEnumValueDescriptorProto | Properties to set |
Returns
EnumValueDescriptorProto instance
decode
▸ decode(reader, length?): EnumValueDescriptorProto
Decodes an EnumValueDescriptorProto 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
EnumValueDescriptorProto
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): EnumValueDescriptorProto
Decodes an EnumValueDescriptorProto message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
EnumValueDescriptorProto
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 EnumValueDescriptorProto message. Does not implicitly google.protobuf.EnumValueDescriptorProto.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IEnumValueDescriptorProto | EnumValueDescriptorProto message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified EnumValueDescriptorProto message, length delimited. Does not implicitly google.protobuf.EnumValueDescriptorProto.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IEnumValueDescriptorProto | EnumValueDescriptorProto message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): EnumValueDescriptorProto
Creates an EnumValueDescriptorProto message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
EnumValueDescriptorProto
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for EnumValueDescriptorProto
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 EnumValueDescriptorProto message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | EnumValueDescriptorProto | EnumValueDescriptorProto |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object