FieldOptions

google.protobuf. FieldOptions

Represents a FieldOptions.

Constructor

new FieldOptions(propertiesopt)

Constructs a new FieldOptions.

Parameters:
Name Type Attributes Description
properties google.protobuf.IFieldOptions <optional>

Properties to set
Implements:
  • IFieldOptions

Members

CType

CType enum.

Properties:
Name Type Description
STRING number

STRING value
CORD number

CORD value
STRING_PIECE number

STRING_PIECE value

JSType

JSType enum.

Properties:
Name Type Description
JS_NORMAL number

JS_NORMAL value
JS_STRING number

JS_STRING value
JS_NUMBER number

JS_NUMBER value

ctype

FieldOptions ctype.

deprecated

FieldOptions deprecated.

jstype

FieldOptions jstype.

lazy

FieldOptions lazy.

packed

FieldOptions packed.

uninterpretedOption

FieldOptions uninterpretedOption.

unverifiedLazy

FieldOptions unverifiedLazy.

weak

FieldOptions weak.

Methods

(static) create(propertiesopt) → {google.protobuf.FieldOptions}

Creates a new FieldOptions instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.protobuf.IFieldOptions <optional>

Properties to set
Returns:
Type Description
google.protobuf.FieldOptions

FieldOptions instance

(static) decode(reader, lengthopt) → {google.protobuf.FieldOptions}

Decodes a FieldOptions message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
length number <optional>

Message length if known beforehand
Returns:
Type Description
google.protobuf.FieldOptions

FieldOptions
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.protobuf.FieldOptions}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
Returns:
Type Description
google.protobuf.FieldOptions

FieldOptions
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified FieldOptions message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.protobuf.IFieldOptions

FieldOptions message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to
Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified FieldOptions message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.protobuf.IFieldOptions

FieldOptions message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to
Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.protobuf.FieldOptions}

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

Parameters:
Name Type Description
object Object.<string, *>

Plain object
Returns:
Type Description
google.protobuf.FieldOptions

FieldOptions

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.protobuf.FieldOptions

FieldOptions
options $protobuf.IConversionOptions <optional>

Conversion options
Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a FieldOptions message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify
Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not

toJSON() → {Object.<string, *>}

Converts this FieldOptions to JSON.

Returns:
Type Description
Object.<string, *>

JSON object