Class AnnotationRefImpl

Annotations allow you to attach information to your API

Hierarchy

ReferenceImpl
- AnnotationRefImpl

Implements

Index

Constructors

constructor

Properties

_meta
attr

Methods

Constructors

constructor

new AnnotationRefImpl(attr: IAttribute): AnnotationRefImpl

Inherited from AttributeNodeImpl.constructor
- Defined in src/raml1/wrapped-ast/parserCore.ts:404
Parameters
- attr: IAttribute
Returns AnnotationRefImpl

Properties

Protected _meta

_meta: ValueMetadataImpl

Protected attr

attr: IAttribute

Methods

RAMLVersion

RAMLVersion(): string

Implementation of AnnotationRef.RAMLVersion

Overwrites ReferenceImpl.RAMLVersion
- Defined in src/raml1/artifacts/raml10parser.ts:4508
Returns string

RAML version of the node

annotation

annotation(): TypeDeclaration

Implementation of AnnotationRef.annotation
- Defined in src/raml1/artifacts/raml10parser.ts:4510
Returns TypeDeclaration

highLevel

highLevel(): IAttribute

Implementation of AnnotationRef.highLevel

Inherited from AttributeNodeImpl.highLevel
- Defined in src/raml1/wrapped-ast/parserCore.ts:413
Returns IAttribute

Underlying High Level attribute node

kind

kind(): string

Implementation of AnnotationRef.kind

Overwrites ReferenceImpl.kind
- Defined in src/raml1/artifacts/raml10parser.ts:4502
Returns string

Actual name of instance interface

meta

meta(): ValueMetadataImpl

Implementation of AnnotationRef.meta

Inherited from AttributeNodeImpl.meta
- Defined in src/raml1/wrapped-ast/parserCore.ts:434
Returns ValueMetadataImpl

name

name(): string

Implementation of AnnotationRef.name

Inherited from ReferenceImpl.name
- Defined in src/raml1/artifacts/raml10parser.ts:727
Returns string

optional

optional(): boolean

Implementation of AnnotationRef.optional

Inherited from AttributeNodeImpl.optional
- Defined in src/raml1/wrapped-ast/parserCore.ts:429
Returns boolean

Whether the element is an optional sibling of trait or resource type

parent

parent(): BasicNode

Implementation of AnnotationRef.parent

Inherited from AttributeNodeImpl.parent
- Defined in src/raml1/wrapped-ast/parserCore.ts:442
Returns BasicNode

structuredValue

structuredValue(): TypeInstance

Implementation of AnnotationRef.structuredValue

Inherited from ReferenceImpl.structuredValue
- Defined in src/raml1/artifacts/raml10parser.ts:723
Returns TypeInstance

toJSON

toJSON(serializeOptions?: SerializeOptions): any

Inherited from AttributeNodeImpl.toJSON
- Defined in src/raml1/wrapped-ast/parserCore.ts:447
Parameters
- Optional serializeOptions: SerializeOptions
Returns any

value

value(): IStructuredValue

Implementation of AnnotationRef.value

Inherited from ReferenceImpl.value
- Defined in src/raml1/artifacts/raml10parser.ts:721
Returns IStructuredValue

StructuredValue object representing the node value

Generated using TypeDoc