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