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