Skip to main content

Class: Location

Represents a Location.

Properties​

leadingComments​

leadingComments: string

If this SourceCodeInfo represents a complete declaration, these are any comments appearing before and after the declaration which appear to be attached to the declaration.

A series of line comments appearing on consecutive lines, with no other tokens appearing on those lines, will be treated as a single comment.

leading_detached_comments will keep paragraphs of comments that appear before (but not connected to) the current element. Each paragraph, separated by empty lines, will be one comment element in the repeated field.

Only the comment content is provided; comment markers (e.g. //) are stripped out. For block comments, leading whitespace and an asterisk will be stripped from the beginning of each line other than the first. Newlines are included in the output.

Examples:

optional int32 foo = 1; // Comment attached to foo. // Comment attached to bar. optional int32 bar = 2;

optional string baz = 3; // Comment attached to baz. // Another line attached to baz.

// Comment attached to moo. // // Another line attached to moo. optional double moo = 4;

// Detached comment for corge. This is not leading or trailing comments // to moo or corge because there are blank lines separating it from // both.

// Detached comment for corge paragraph 2.

optional string corge = 5; /* Block comment attached

  • to corge. Leading asterisks
  • will be removed. * / /* Block comment attached to
  • grault. * / optional int32 grault = 6;

// ignored detached comments.

leadingDetachedComments​

leadingDetachedComments: string[]

Location leadingDetachedComments.

path​

path: number[]

Identifies which part of the FileDescriptorProto was defined at this location.

Each element is a field number or an index. They form a path from the root FileDescriptorProto to the place where the definition occurs. For example, this path: [ 4, 3, 2, 7, 1 ] refers to: file.message_type(3) // 4, 3 .field(7) // 2, 7 .name() // 1 This is because FileDescriptorProto.message_type has field number 4: repeated DescriptorProto message_type = 4; and DescriptorProto.field has field number 2: repeated FieldDescriptorProto field = 2; and FieldDescriptorProto.name has field number 1: optional string name = 1;

Thus, the above path gives the location of a field name. If we removed the last element: [ 4, 3, 2, 7 ] this path refers to the whole field declaration (from the beginning of the label to the terminating semicolon).

span​

span: number[]

Always has exactly three or four elements: start line, start column, end line (optional, otherwise assumed same as start line), end column. These are packed into a single field for efficiency. Note that line and column numbers are zero-based -- typically you will want to add 1 to each before displaying to a user.

trailingComments​

trailingComments: string

Location trailingComments.

Methods​

toJSON()​

toJSON(): object

Converts this Location to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): Location & $Properties

Creates a new Location instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Location & $Properties

Location instance

Call Signature​

static create(properties?): Location

Creates a new Location instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Location

Location instance

decode()​

static decode(reader, length?): Location & $Properties

Decodes a Location message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

Location & $Properties

Location

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): Location & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

Location & $Properties

Location

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified Location message. Does not implicitly google.protobuf.SourceCodeInfo.Location.verify|verify messages.

Parameters​

message​

$Properties

Location message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified Location message, length delimited. Does not implicitly google.protobuf.SourceCodeInfo.Location.verify|verify messages.

Parameters​

message​

$Properties

Location message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): Location

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

Location

Location

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

Location

Location

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object