Skip to main content

Class: 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()​

Call Signature​

static create(properties?): Annotation & $Properties

Creates a new Annotation instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Annotation & $Properties

Annotation instance

Call Signature​

static create(properties?): Annotation

Creates a new Annotation instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Annotation

Annotation instance

decode()​

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

Decodes an Annotation 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​

Annotation & $Properties

Annotation

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): Annotation & $Properties

Decodes an Annotation message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

Annotation & $Properties

Annotation

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 Annotation message. Does not implicitly google.protobuf.GeneratedCodeInfo.Annotation.verify|verify messages.

Parameters​

message​

$Properties

Annotation message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

Annotation message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): Annotation

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

Annotation

Annotation

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

Annotation

Annotation

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object