Class: EnumDescriptorProto
google.protobuf.EnumDescriptorProto
Describes an enum type.
Implements
Constructors
constructor
• new EnumDescriptorProto(properties?): EnumDescriptorProto
Constructs a new EnumDescriptorProto.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IEnumDescriptorProto | Properties to set |
Returns
Properties
name
• name: string
EnumDescriptorProto name.
Implementation of
options
• Optional options: null | IEnumOptions
EnumDescriptorProto options.
Implementation of
reservedName
• reservedName: string[]
Reserved enum value names, which may not be reused. A given name may only be reserved once.
Implementation of
IEnumDescriptorProto.reservedName
reservedRange
• reservedRange: IEnumReservedRange[]
Range of reserved numeric values. Reserved numeric values may not be used by enum values in the same enum declaration. Reserved ranges may not overlap.
Implementation of
IEnumDescriptorProto.reservedRange
value
• value: IEnumValueDescriptorProto[]
EnumDescriptorProto value.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this EnumDescriptorProto to JSON.
Returns
Object
JSON object
create
▸ create(properties?): EnumDescriptorProto
Creates a new EnumDescriptorProto instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IEnumDescriptorProto | Properties to set |
Returns
EnumDescriptorProto instance
decode
▸ decode(reader, length?): EnumDescriptorProto
Decodes an EnumDescriptorProto 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
EnumDescriptorProto
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): EnumDescriptorProto
Decodes an EnumDescriptorProto message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
EnumDescriptorProto
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 EnumDescriptorProto message. Does not implicitly google.protobuf.EnumDescriptorProto.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IEnumDescriptorProto | EnumDescriptorProto message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified EnumDescriptorProto message, length delimited. Does not implicitly google.protobuf.EnumDescriptorProto.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IEnumDescriptorProto | EnumDescriptorProto message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): EnumDescriptorProto
Creates an EnumDescriptorProto message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
EnumDescriptorProto
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for EnumDescriptorProto
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 EnumDescriptorProto message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | EnumDescriptorProto | EnumDescriptorProto |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object