Class: Annotation
protobuf.GeneratedCodeInfo.Annotation
Represents an Annotation.
Implements
Constructors
constructor
• new Annotation(properties?): Annotation
Constructs a new Annotation.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IAnnotation | Properties to set |
Returns
Properties
begin
• begin: number
Identifies the starting offset in bytes in the generated code that relates to the identified object.
Implementation of
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).
Implementation of
path
• path: number[]
Identifies the element in the original source .proto file. This field is formatted the same as SourceCodeInfo.Location.path.
Implementation of
semantic
• semantic: Semantic
Annotation semantic.
Implementation of
sourceFile
• sourceFile: string
Identifies the filesystem path to the original source .proto.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this Annotation to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Annotation
Creates a new Annotation instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IAnnotation | Properties to set |
Returns
Annotation instance
decode
▸ decode(reader, length?): Annotation
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
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 | IAnnotation | 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 | IAnnotation | 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
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for Annotation
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 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