JSDoc: Class: Location

new Location(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 832

Extends

jspb.Message

Members

(static) displayName

Source:

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

Methods

addLeadingDetachedComments(value, opt_indexopt) → (non-null) {proto.google.protobuf.SourceCodeInfo.Location}

Parameters:

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

Source:

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

Returns:

returns this

Type: proto.google.protobuf.SourceCodeInfo.Location

addPath(value, opt_indexopt) → (non-null) {proto.google.protobuf.SourceCodeInfo.Location}

Parameters:

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

Source:

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

Returns:

returns this

Type: proto.google.protobuf.SourceCodeInfo.Location

addSpan(value, opt_indexopt) → (non-null) {proto.google.protobuf.SourceCodeInfo.Location}

Parameters:

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

Source:

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

Returns:

returns this

Type: proto.google.protobuf.SourceCodeInfo.Location

clearLeadingComments() → (non-null) {proto.google.protobuf.SourceCodeInfo.Location}

Clears the field making it undefined.

Source:

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

Returns:

returns this

Type: proto.google.protobuf.SourceCodeInfo.Location

clearLeadingDetachedCommentsList() → (non-null) {proto.google.protobuf.SourceCodeInfo.Location}

Clears the list making it empty but non-null.

Source:

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

Returns:

returns this

Type: proto.google.protobuf.SourceCodeInfo.Location

clearPathList() → (non-null) {proto.google.protobuf.SourceCodeInfo.Location}

Clears the list making it empty but non-null.

Source:

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

Returns:

returns this

Type: proto.google.protobuf.SourceCodeInfo.Location

clearSpanList() → (non-null) {proto.google.protobuf.SourceCodeInfo.Location}

Clears the list making it empty but non-null.

Source:

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

Returns:

returns this

Type: proto.google.protobuf.SourceCodeInfo.Location

clearTrailingComments() → (non-null) {proto.google.protobuf.SourceCodeInfo.Location}

Clears the field making it undefined.

Source:

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

Returns:

returns this

Type: proto.google.protobuf.SourceCodeInfo.Location

getLeadingComments() → {string}

optional string leading_comments = 3;

Source:

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

Returns:

Type: string

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

repeated string leading_detached_comments = 6;

Source:

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

Returns:

Type: Array.<string>

getPathList() → (non-null) {Array.<number>}

repeated int32 path = 1;

Source:

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

Returns:

Type: Array.<number>

getSpanList() → (non-null) {Array.<number>}

repeated int32 span = 2;

Source:

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

Returns:

Type: Array.<number>

getTrailingComments() → {string}

optional string trailing_comments = 4;

Source:

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

Returns:

Type: string

hasLeadingComments() → {boolean}

Returns whether this field is set.

Source:

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

Returns:

Type: boolean

hasTrailingComments() → {boolean}

Returns whether this field is set.

Source:

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

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 9322

Returns:

Type: Uint8Array

setLeadingComments(value) → (non-null) {proto.google.protobuf.SourceCodeInfo.Location}

Parameters:

Name	Type	Description
`value`	string

Source:

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

Returns:

returns this

Type: proto.google.protobuf.SourceCodeInfo.Location

setLeadingDetachedCommentsList(valuenon-null) → (non-null) {proto.google.protobuf.SourceCodeInfo.Location}

Parameters:

Name	Type	Description
`value`	Array.<string>

Source:

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

Returns:

returns this

Type: proto.google.protobuf.SourceCodeInfo.Location

setPathList(valuenon-null) → (non-null) {proto.google.protobuf.SourceCodeInfo.Location}

Parameters:

Name	Type	Description
`value`	Array.<number>

Source:

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

Returns:

returns this

Type: proto.google.protobuf.SourceCodeInfo.Location

setSpanList(valuenon-null) → (non-null) {proto.google.protobuf.SourceCodeInfo.Location}

Parameters:

Name	Type	Description
`value`	Array.<number>

Source:

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

Returns:

returns this

Type: proto.google.protobuf.SourceCodeInfo.Location

setTrailingComments(value) → (non-null) {proto.google.protobuf.SourceCodeInfo.Location}

Parameters:

Name	Type	Description
`value`	string

Source:

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

Returns:

returns this

Type: proto.google.protobuf.SourceCodeInfo.Location

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 9232

Returns:

Type: Object

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

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 9268

Returns:

Type: proto.google.protobuf.SourceCodeInfo.Location

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

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

Parameters:

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

Source:

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

Returns:

Type: proto.google.protobuf.SourceCodeInfo.Location

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

Source:

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

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

Source:

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

Returns:

Type: Object