JSDoc: Class: FieldOptions

new FieldOptions(opt_dataopt)

Generated by JsPbCodeGenerator.

Parameters:

Name	Type	Attributes	Description
`opt_data`	Array	<optional>	Optional initial data array, typically from a server response, or constructed directly in Javascript. The array is used in place and becomes part of the constructed object. It is not cloned. If no data is provided, the constructed object will be empty, but still valid.

Source:

proto/google/protobuf/descriptor_pb.js, line 463

Extends

jspb.Message

Members

(static) CType :number

Type:

number

Properties:

Name	Type	Description
`STRING`	number
`CORD`	number
`STRING_PIECE`	number

Source:

proto/google/protobuf/descriptor_pb.js, line 7013

(static) JSType :number

Type:

number

Properties:

Name	Type	Description
`JS_NORMAL`	number
`JS_STRING`	number
`JS_NUMBER`	number

Source:

proto/google/protobuf/descriptor_pb.js, line 7022

(static) displayName

Source:

proto/google/protobuf/descriptor_pb.js, line 472

(static, non-null) extensions :Object.<number, jspb.ExtensionFieldInfo>

The extensions registered with this message class. This is a map of extension field number to fieldInfo object. For example: { 123: {fieldIndex: 123, fieldName: {my_field_name: 0}, ctor: proto.example.MyMessage} } fieldName contains the JsCompiler renamed field name property so that it works in OPTIMIZED mode.

Type:

Object.<number, jspb.ExtensionFieldInfo>

Source:

proto/google/protobuf/descriptor_pb.js, line 487

(static, non-null) extensionsBinary :Object.<number, jspb.ExtensionFieldBinaryInfo>

Type:

Object.<number, jspb.ExtensionFieldBinaryInfo>

Source:

proto/google/protobuf/descriptor_pb.js, line 502

Methods

addUninterpretedOption(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.google.protobuf.UninterpretedOption}

Parameters:

Name	Type	Attributes	Description
`opt_value`	proto.google.protobuf.UninterpretedOption	<optional>
`opt_index`	number	<optional>

Source:

proto/google/protobuf/descriptor_pb.js, line 7268

Returns:

Type: proto.google.protobuf.UninterpretedOption

clearCtype() → (non-null) {proto.google.protobuf.FieldOptions}

Clears the field making it undefined.

Source:

proto/google/protobuf/descriptor_pb.js, line 7050

Returns:

returns this

Type: proto.google.protobuf.FieldOptions

clearDeprecated() → (non-null) {proto.google.protobuf.FieldOptions}

Clears the field making it undefined.

Source:

proto/google/protobuf/descriptor_pb.js, line 7194

Returns:

returns this

Type: proto.google.protobuf.FieldOptions

clearJstype() → (non-null) {proto.google.protobuf.FieldOptions}

Clears the field making it undefined.

Source:

proto/google/protobuf/descriptor_pb.js, line 7122

Returns:

returns this

Type: proto.google.protobuf.FieldOptions

clearLazy() → (non-null) {proto.google.protobuf.FieldOptions}

Clears the field making it undefined.

Source:

proto/google/protobuf/descriptor_pb.js, line 7158

Returns:

returns this

Type: proto.google.protobuf.FieldOptions

clearPacked() → (non-null) {proto.google.protobuf.FieldOptions}

Clears the field making it undefined.

Source:

proto/google/protobuf/descriptor_pb.js, line 7086

Returns:

returns this

Type: proto.google.protobuf.FieldOptions

clearUninterpretedOptionList() → (non-null) {proto.google.protobuf.FieldOptions}

Clears the list making it empty but non-null.

Source:

proto/google/protobuf/descriptor_pb.js, line 7277

Returns:

returns this

Type: proto.google.protobuf.FieldOptions

clearWeak() → (non-null) {proto.google.protobuf.FieldOptions}

Clears the field making it undefined.

Source:

proto/google/protobuf/descriptor_pb.js, line 7230

Returns:

returns this

Type: proto.google.protobuf.FieldOptions

getCtype() → (non-null) {proto.google.protobuf.FieldOptions.CType}

optional CType ctype = 1;

Source:

proto/google/protobuf/descriptor_pb.js, line 7032

Returns:

Type: proto.google.protobuf.FieldOptions.CType

getDeprecated() → {boolean}

optional bool deprecated = 3;

Source:

proto/google/protobuf/descriptor_pb.js, line 7176

Returns:

Type: boolean

getJstype() → (non-null) {proto.google.protobuf.FieldOptions.JSType}

optional JSType jstype = 6;

Source:

proto/google/protobuf/descriptor_pb.js, line 7104

Returns:

Type: proto.google.protobuf.FieldOptions.JSType

getLazy() → {boolean}

optional bool lazy = 5;

Source:

proto/google/protobuf/descriptor_pb.js, line 7140

Returns:

Type: boolean

getPacked() → {boolean}

optional bool packed = 2;

Source:

proto/google/protobuf/descriptor_pb.js, line 7068

Returns:

Type: boolean

getUninterpretedOptionList() → (non-null) {Array.<!proto.google.protobuf.UninterpretedOption>}

repeated UninterpretedOption uninterpreted_option = 999;

Source:

proto/google/protobuf/descriptor_pb.js, line 7248

Returns:

Type: Array.<!proto.google.protobuf.UninterpretedOption>

getWeak() → {boolean}

optional bool weak = 10;

Source:

proto/google/protobuf/descriptor_pb.js, line 7212

Returns:

Type: boolean

hasCtype() → {boolean}

Returns whether this field is set.

Source:

proto/google/protobuf/descriptor_pb.js, line 7059

Returns:

Type: boolean

hasDeprecated() → {boolean}

Returns whether this field is set.

Source:

proto/google/protobuf/descriptor_pb.js, line 7203

Returns:

Type: boolean

hasJstype() → {boolean}

Returns whether this field is set.

Source:

proto/google/protobuf/descriptor_pb.js, line 7131

Returns:

Type: boolean

hasLazy() → {boolean}

Returns whether this field is set.

Source:

proto/google/protobuf/descriptor_pb.js, line 7167

Returns:

Type: boolean

hasPacked() → {boolean}

Returns whether this field is set.

Source:

proto/google/protobuf/descriptor_pb.js, line 7095

Returns:

Type: boolean

hasWeak() → {boolean}

Returns whether this field is set.

Source:

proto/google/protobuf/descriptor_pb.js, line 7239

Returns:

Type: boolean

serializeBinary() → (non-null) {Uint8Array}

Serializes the message to binary data (in protobuf wire format).

Source:

proto/google/protobuf/descriptor_pb.js, line 6939

Returns:

Type: Uint8Array

setCtype(valuenon-null) → (non-null) {proto.google.protobuf.FieldOptions}

Parameters:

Name	Type	Description
`value`	proto.google.protobuf.FieldOptions.CType

Source:

proto/google/protobuf/descriptor_pb.js, line 7041

Returns:

returns this

Type: proto.google.protobuf.FieldOptions

setDeprecated(value) → (non-null) {proto.google.protobuf.FieldOptions}

Parameters:

Name	Type	Description
`value`	boolean

Source:

proto/google/protobuf/descriptor_pb.js, line 7185

Returns:

returns this

Type: proto.google.protobuf.FieldOptions

setJstype(valuenon-null) → (non-null) {proto.google.protobuf.FieldOptions}

Parameters:

Name	Type	Description
`value`	proto.google.protobuf.FieldOptions.JSType

Source:

proto/google/protobuf/descriptor_pb.js, line 7113

Returns:

returns this

Type: proto.google.protobuf.FieldOptions

setLazy(value) → (non-null) {proto.google.protobuf.FieldOptions}

Parameters:

Name	Type	Description
`value`	boolean

Source:

proto/google/protobuf/descriptor_pb.js, line 7149

Returns:

returns this

Type: proto.google.protobuf.FieldOptions

setPacked(value) → (non-null) {proto.google.protobuf.FieldOptions}

Parameters:

Name	Type	Description
`value`	boolean

Source:

proto/google/protobuf/descriptor_pb.js, line 7077

Returns:

returns this

Type: proto.google.protobuf.FieldOptions

setUninterpretedOptionList(valuenon-null) → (non-null) {proto.google.protobuf.FieldOptions}

Parameters:

Name	Type	Description
`value`	Array.<!proto.google.protobuf.UninterpretedOption>

Source:

proto/google/protobuf/descriptor_pb.js, line 7258

Returns:

returns this

Type: proto.google.protobuf.FieldOptions

setWeak(value) → (non-null) {proto.google.protobuf.FieldOptions}

Parameters:

Name	Type	Description
`value`	boolean

Source:

proto/google/protobuf/descriptor_pb.js, line 7221

Returns:

returns this

Type: proto.google.protobuf.FieldOptions

toObject(opt_includeInstanceopt) → (non-null) {Object}

Creates an object representation of this proto. Field names that are reserved in JavaScript and will be renamed to pb_name. Optional fields that are not set will be set to undefined. To access a reserved field use, foo.pb_, eg, foo.pb_default. For the list of reserved names please see: net/proto2/compiler/js/internal/generator.cc#kKeyword.

Parameters:

Name	Type	Attributes	Description
`opt_includeInstance`	boolean	<optional>	Deprecated. whether to include the JSPB instance for transitional soy proto support: http://goto/soy-param-migration

Source:

proto/google/protobuf/descriptor_pb.js, line 6831

Returns:

Type: Object

(static) deserializeBinary(bytes) → (non-null) {proto.google.protobuf.FieldOptions}

Deserializes binary data (in protobuf wire format).

Parameters:

Name	Type	Description
`bytes`	jspb.ByteSource	The bytes to deserialize.

Source:

proto/google/protobuf/descriptor_pb.js, line 6873

Returns:

Type: proto.google.protobuf.FieldOptions

(static) deserializeBinaryFromReader(msgnon-null, readernon-null) → (non-null) {proto.google.protobuf.FieldOptions}

Deserializes binary data (in protobuf wire format) from the given reader into the given message object.

Parameters:

Name	Type	Description
`msg`	proto.google.protobuf.FieldOptions	The message object to deserialize into.
`reader`	jspb.BinaryReader	The BinaryReader to use.

Source:

proto/google/protobuf/descriptor_pb.js, line 6887

Returns:

Type: proto.google.protobuf.FieldOptions

(static) serializeBinaryToWriter(messagenon-null, writernon-null)

Serializes the given message to binary data (in protobuf wire format), writing to the given BinaryWriter.

Parameters:

Name	Type	Description
`message`	proto.google.protobuf.FieldOptions
`writer`	jspb.BinaryWriter

Source:

proto/google/protobuf/descriptor_pb.js, line 6953

(static) toObject(includeInstance, msgnon-null) → (non-null) {Object}

Static version of the {@see toObject} method.

Parameters:

Name	Type	Description
`includeInstance`	boolean \| undefined	Deprecated. Whether to include the JSPB instance for transitional soy proto support: http://goto/soy-param-migration
`msg`	proto.google.protobuf.FieldOptions	The msg instance to transform.

Source:

proto/google/protobuf/descriptor_pb.js, line 6845

Returns:

Type: Object