Interface MarkdownString

Mardown string is a string which can contain markdown as an extension this markdown should support links with RAML Pointers since 1.0

Hierarchy

StringType
- MarkdownString

Index

Methods

Methods

RAMLVersion

RAMLVersion(): string

Inherited from AbstractWrapperNode.RAMLVersion
- Defined in src/raml1/highLevelAST.ts:22
Returns string

RAML version of the node. "RAML10" for RAML 1.0 and "RAML08" for RAML 0.8.

highLevel

highLevel(): IAttribute

Inherited from AttributeNode.highLevel
- Defined in src/raml1/wrapped-ast/parserCoreApi.ts:13
Returns IAttribute

Underlying High Level attribute node

kind

kind(): string

Inherited from AbstractWrapperNode.kind
- Defined in src/raml1/highLevelAST.ts:17
Returns string

Actual name of instance interface

meta

meta(): ValueMetadata

Inherited from AttributeNode.meta
- Defined in src/raml1/wrapped-ast/parserCoreApi.ts:20
Returns ValueMetadata

optional

optional(): boolean

Inherited from AttributeNode.optional
- Defined in src/raml1/wrapped-ast/parserCoreApi.ts:18
Returns boolean

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

parent

parent(): BasicNode

Inherited from AttributeNode.parent
- Defined in src/raml1/wrapped-ast/parserCoreApi.ts:22
Returns BasicNode

toJSON

toJSON(): any

Inherited from AttributeNode.toJSON
- Defined in src/raml1/wrapped-ast/parserCoreApi.ts:27
JSON representation of the attribute value

Returns any

value

value(): string

Inherited from StringType.value

Overwrites ValueType.value
- Defined in src/raml1/artifacts/raml08parserapi.ts:409
Returns string

String representation of the node value

Generated using TypeDoc