Skip to main content

Class: Annotation

protobuf.GeneratedCodeInfo.Annotation

Represents an Annotation.

Implements

Constructors

constructor

new Annotation(properties?)

Constructs a new Annotation.

Parameters

NameTypeDescription
properties?IAnnotationProperties to set

Properties

begin

begin: number

Annotation begin.

Implementation of

IAnnotation.begin


end

end: number

Annotation end.

Implementation of

IAnnotation.end


path

path: number[]

Annotation path.

Implementation of

IAnnotation.path


sourceFile

sourceFile: string

Annotation sourceFile.

Implementation of

IAnnotation.sourceFile

Methods

toJSON

toJSON(): Object

Converts this Annotation to JSON.

Returns

Object

JSON object


create

Static create(properties?): Annotation

Creates a new Annotation instance using the specified properties.

Parameters

NameTypeDescription
properties?IAnnotationProperties to set

Returns

Annotation

Annotation instance


decode

Static decode(reader, length?): Annotation

Decodes an Annotation message from the specified reader or buffer.

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

Annotation

Annotation


decodeDelimited

Static decodeDelimited(reader): Annotation

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

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

Annotation

Annotation


encode

Static encode(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIAnnotationAnnotation message or plain object to encode
writer?WriterWriter 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

NameTypeDescription
messageIAnnotationAnnotation message or plain object to encode
writer?WriterWriter 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

NameTypeDescription
objectObjectPlain object

Returns

Annotation

Annotation


getTypeUrl

Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for Annotation

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

Static toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageAnnotationAnnotation
options?IConversionOptionsConversion options

Returns

Object

Plain object