Generated

from message google.protobuf.EnumOptions

Hierarchy

Constructors

Properties

allowAlias?: boolean

Set this option to true to allow mapping different tag names to the same value.

Generated

from field: optional bool allow_alias = 2;

deprecated?: boolean

Is this enum deprecated? Depending on the target platform, this can emit Deprecated annotations for the enum, or it will be completely ignored; in the very least, this is a formalization for deprecating enums.

Generated

from field: optional bool deprecated = 3 [default = false];

deprecatedLegacyJsonFieldConflicts?: boolean

Enable the legacy handling of JSON field name conflicts. This lowercases and strips underscored from the fields before comparison in proto3 only. The new behavior takes json_name into account and applies to proto2 as well. TODO(b/261750190) Remove this legacy behavior once downstream teams have had time to migrate.

Generated

from field: optional bool deprecated_legacy_json_field_conflicts = 6 [deprecated = true];

Deprecated

uninterpretedOption: UninterpretedOption[]

The parser stores options it doesn't recognize here. See above.

Generated

from field: repeated google.protobuf.UninterpretedOption uninterpreted_option = 999;

fields: FieldList
runtime: ProtoRuntime
typeName: "google.protobuf.EnumOptions" = "google.protobuf.EnumOptions"

Methods

  • Create a deep copy.

    Returns EnumOptions

  • Compare with a message of the same type.

    Parameters

    Returns boolean

  • 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.

    Parameters

    Returns EnumOptions

  • Parse a message from a JSON value.

    Parameters

    Returns EnumOptions

  • Parse a message from a JSON string.

    Parameters

    Returns EnumOptions

  • Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.

    Returns MessageType<EnumOptions>

  • Serialize the message to binary data.

    Parameters

    Returns Uint8Array

  • Override 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.

    Returns JsonValue

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    Returns JsonValue

  • Serialize the message to a JSON string.

    Parameters

    Returns string

  • Parameters

    Returns EnumOptions

  • Parameters

    Returns EnumOptions

  • Parameters

    Returns EnumOptions

Generated using TypeDoc