JSDoc: Class: Type

new Type(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/type_pb.js, line 37

Extends

jspb.Message

Members

(static) displayName

Source:

proto/google/protobuf/type_pb.js, line 46

Methods

addFields(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.google.protobuf.Field}

Parameters:

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

Source:

proto/google/protobuf/type_pb.js, line 361

Returns:

Type: proto.google.protobuf.Field

addOneofs(value, opt_indexopt) → (non-null) {proto.google.protobuf.Type}

Parameters:

Name	Type	Attributes	Description
`value`	string
`opt_index`	number	<optional>

Source:

proto/google/protobuf/type_pb.js, line 398

Returns:

returns this

Type: proto.google.protobuf.Type

addOptions(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.google.protobuf.Option}

Parameters:

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

Source:

proto/google/protobuf/type_pb.js, line 436

Returns:

Type: proto.google.protobuf.Option

clearFieldsList() → (non-null) {proto.google.protobuf.Type}

Clears the list making it empty but non-null.

Source:

proto/google/protobuf/type_pb.js, line 370

Returns:

returns this

Type: proto.google.protobuf.Type

clearOneofsList() → (non-null) {proto.google.protobuf.Type}

Clears the list making it empty but non-null.

Source:

proto/google/protobuf/type_pb.js, line 407

Returns:

returns this

Type: proto.google.protobuf.Type

clearOptionsList() → (non-null) {proto.google.protobuf.Type}

Clears the list making it empty but non-null.

Source:

proto/google/protobuf/type_pb.js, line 445

Returns:

returns this

Type: proto.google.protobuf.Type

clearSourceContext() → (non-null) {proto.google.protobuf.Type}

Clears the message field making it undefined.

Source:

proto/google/protobuf/type_pb.js, line 473

Returns:

returns this

Type: proto.google.protobuf.Type

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

repeated Field fields = 2;

Source:

proto/google/protobuf/type_pb.js, line 341

Returns:

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

getName() → {string}

optional string name = 1;

Source:

proto/google/protobuf/type_pb.js, line 323

Returns:

Type: string

getOneofsList() → (non-null) {Array.<string>}

repeated string oneofs = 3;

Source:

proto/google/protobuf/type_pb.js, line 379

Returns:

Type: Array.<string>

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

repeated Option options = 4;

Source:

proto/google/protobuf/type_pb.js, line 416

Returns:

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

getSourceContext() → (nullable) {proto.google.protobuf.SourceContext}

optional SourceContext source_context = 5;

Source:

proto/google/protobuf/type_pb.js, line 454

Returns:

Type: proto.google.protobuf.SourceContext

getSyntax() → (non-null) {proto.google.protobuf.Syntax}

optional Syntax syntax = 6;

Source:

proto/google/protobuf/type_pb.js, line 491

Returns:

Type: proto.google.protobuf.Syntax

hasSourceContext() → {boolean}

Returns whether this field is set.

Source:

proto/google/protobuf/type_pb.js, line 482

Returns:

Type: boolean

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

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

Source:

proto/google/protobuf/type_pb.js, line 255

Returns:

Type: Uint8Array

setFieldsList(valuenon-null) → (non-null) {proto.google.protobuf.Type}

Parameters:

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

Source:

proto/google/protobuf/type_pb.js, line 351

Returns:

returns this

Type: proto.google.protobuf.Type

setName(value) → (non-null) {proto.google.protobuf.Type}

Parameters:

Name	Type	Description
`value`	string

Source:

proto/google/protobuf/type_pb.js, line 332

Returns:

returns this

Type: proto.google.protobuf.Type

setOneofsList(valuenon-null) → (non-null) {proto.google.protobuf.Type}

Parameters:

Name	Type	Description
`value`	Array.<string>

Source:

proto/google/protobuf/type_pb.js, line 388

Returns:

returns this

Type: proto.google.protobuf.Type

setOptionsList(valuenon-null) → (non-null) {proto.google.protobuf.Type}

Parameters:

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

Source:

proto/google/protobuf/type_pb.js, line 426

Returns:

returns this

Type: proto.google.protobuf.Type

setSourceContext(value) → (non-null) {proto.google.protobuf.Type}

Parameters:

Name	Type	Description
`value`	proto.google.protobuf.SourceContext \| undefined

Source:

proto/google/protobuf/type_pb.js, line 464

Returns:

returns this

Type: proto.google.protobuf.Type

setSyntax(valuenon-null) → (non-null) {proto.google.protobuf.Type}

Parameters:

Name	Type	Description
`value`	proto.google.protobuf.Syntax

Source:

proto/google/protobuf/type_pb.js, line 500

Returns:

returns this

Type: proto.google.protobuf.Type

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/type_pb.js, line 155

Returns:

Type: Object

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

Deserializes binary data (in protobuf wire format).

Parameters:

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

Source:

proto/google/protobuf/type_pb.js, line 194

Returns:

Type: proto.google.protobuf.Type

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

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

Parameters:

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

Source:

proto/google/protobuf/type_pb.js, line 208

Returns:

Type: proto.google.protobuf.Type

(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.Type
`writer`	jspb.BinaryWriter

Source:

proto/google/protobuf/type_pb.js, line 269

(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.Type	The msg instance to transform.

Source:

proto/google/protobuf/type_pb.js, line 169

Returns:

Type: Object