Optional
data: PartialMessage<Option>The option's name. For protobuf built-in options (options defined in
descriptor.proto), this is the short name. For example, "map_entry"
.
For custom options, it should be the fully-qualified name. For example,
"google.api.http"
.
from field: string name = 1;
Optional
valueThe option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.
from field: google.protobuf.Any value = 2;
Static
Readonly
fieldsStatic
Readonly
runtimeStatic
Readonly
typeCompare with a message of the same type.
Parse from binary data, merging fields.
Repeated fields are appended. Map entries are added, overwriting existing keys.
If a message field is already present, it will be merged with the new data.
Optional
options: Partial<BinaryReadOptions>Parse a message from a JSON value.
Optional
options: Partial<JsonReadOptions>Parse a message from a JSON string.
Optional
options: Partial<JsonReadOptions>Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.
Serialize the message to binary data.
Optional
options: Partial<BinaryWriteOptions>Protected
toJSONOverride for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).
Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.
This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.
Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().
Optional
options: Partial<JsonWriteOptions>Serialize the message to a JSON string.
Optional
options: Partial<JsonWriteStringOptions>Static
equalsStatic
fromOptional
options: Partial<BinaryReadOptions>Static
fromOptional
options: Partial<JsonReadOptions>Static
fromOptional
options: Partial<JsonReadOptions>Generated using TypeDoc
A protocol buffer option, which can be attached to a message, field, enumeration, etc.
Generated
from message google.protobuf.Option