Skip to main content

Class: MessageOptions

google.protobuf.MessageOptions

Represents a MessageOptions.

Implements#

Constructors#

constructor#

new MessageOptions(properties?)

Constructs a new MessageOptions.

Parameters#

NameType
properties?IMessageOptions

Properties#

deprecated#

deprecated: boolean

MessageOptions deprecated.

Implementation of#

IMessageOptions.deprecated


mapEntry#

mapEntry: boolean

MessageOptions mapEntry.

Implementation of#

IMessageOptions.mapEntry


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


decode#

Static decode(reader, length?): MessageOptions

Decodes a MessageOptions message from the specified reader or buffer.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?number-

Returns#

MessageOptions

MessageOptions


decodeDelimited#

Static decodeDelimited(reader): MessageOptions

Decodes a MessageOptions message from the specified reader or buffer, length delimited.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns#

MessageOptions

MessageOptions


encode#

Static encode(message, writer?): Writer

Encodes the specified MessageOptions message. Does not implicitly {@link google.protobuf.MessageOptions.verify|verify} messages.

Parameters#

NameTypeDescription
messageIMessageOptionsMessageOptions message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

Encodes the specified MessageOptions message, length delimited. Does not implicitly {@link google.protobuf.MessageOptions.verify|verify} messages.

Parameters#

NameTypeDescription
messageIMessageOptionsMessageOptions message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


fromObject#

Static fromObject(object): MessageOptions

Creates a MessageOptions message from a plain object. Also converts values to their respective internal types.

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

MessageOptions

MessageOptions


toObject#

Static toObject(message, options?): Object

Creates a plain object from a MessageOptions message. Also converts values to other types if specified.

Parameters#

NameTypeDescription
messageMessageOptionsMessageOptions
options?IConversionOptions-

Returns#

Object

Plain object