Class: Annotation
protobuf.GeneratedCodeInfo.Annotation
Represents an Annotation.
Properties
begin
• begin: number
Identifies the starting offset in bytes in the generated code that relates to the identified object.
end
• end: number
Identifies the ending offset in bytes in the generated code that relates to the identified object. The end offset should be one past the last relevant byte (so the length of the text = end - begin).
path
• path: number[]
Identifies the element in the original source .proto file. This field is formatted the same as SourceCodeInfo.Location.path.
semantic
• semantic: Semantic
Annotation semantic.
sourceFile
• sourceFile: string
Identifies the filesystem path to the original source .proto.
Methods
toJSON
▸ toJSON(): Object
Converts this Annotation to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Annotation & $Properties
Creates a new Annotation instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
Annotation instance
▸ create(properties?): Annotation
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): Annotation & $Properties
Decodes an Annotation 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
Annotation
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Annotation & $Properties
Decodes an Annotation message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Annotation
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 Annotation message. Does not implicitly google.protobuf.GeneratedCodeInfo.Annotation.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | Annotation message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Annotation message, length delimited. Does not implicitly google.protobuf.GeneratedCodeInfo.Annotation.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | Annotation message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Annotation
Creates an Annotation message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Annotation
toObject
▸ toObject(message, options?): Object
Creates a plain object from an Annotation message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Annotation | Annotation |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object