Class: Location
protobuf.SourceCodeInfo.Location
Represents a Location.
Implements
Constructors
constructor
• new Location(properties?): Location
Constructs a new Location.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ILocation | Properties to set |
Returns
Properties
leadingComments
• leadingComments: string
Location leadingComments.
Implementation of
leadingDetachedComments
• leadingDetachedComments: string[]
Location leadingDetachedComments.
Implementation of
ILocation.leadingDetachedComments
path
• path: number[]
Location path.
Implementation of
span
• span: number[]
Location span.
Implementation of
trailingComments
• trailingComments: string
Location trailingComments.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this Location to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Location
Creates a new Location instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ILocation | Properties to set |
Returns
Location instance
decode
▸ decode(reader, length?): Location
Decodes a Location message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
Location
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Location
Decodes a Location message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Location
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode
▸ encode(message, writer?): Writer
Encodes the specified Location message. Does not implicitly google.protobuf.SourceCodeInfo.Location.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ILocation | Location message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Location message, length delimited. Does not implicitly google.protobuf.SourceCodeInfo.Location.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ILocation | Location message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Location
Creates a Location message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Location
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for Location
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from a Location message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Location | Location |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object