"src/index" | RAML JS Parser 2

Index

Variables

PromiseConstructor

Functions

Variables

PromiseConstructor

PromiseConstructor: any

Functions

asFragment

asFragment(node: Api | Library | Overlay | Extension | Trait | TypeDeclaration | ResourceType | DocumentationItem): FragmentDeclaration

- Defined in src/index.ts:171
Convert fragment representing node to FragmentDeclaration instance.

Parameters
- node: Api | Library | Overlay | Extension | Trait | TypeDeclaration | ResourceType | DocumentationItem
Returns FragmentDeclaration

getLanguageElementByRuntimeType

getLanguageElementByRuntimeType(runtimeType: ITypeDefinition): BasicNode

- Defined in src/index.ts:157
Gets AST node by runtime type, if runtime type matches any.

Parameters
- runtimeType: ITypeDefinition
  
  runtime type to find the match for
Returns BasicNode

isFragment

isFragment(node: Api | Library | Overlay | Extension | Trait | TypeDeclaration | ResourceType | DocumentationItem): boolean

- Defined in src/index.ts:164
Check if the AST node represents fragment

Parameters
- node: Api | Library | Overlay | Extension | Trait | TypeDeclaration | ResourceType | DocumentationItem
Returns boolean

loadApi

loadApi(apiPath: string, options?: Options): Promise<Api | Api>
loadApi(apiPath: string, extensionsAndOverlays: string[], options?: Options): Promise<Api | Api>

- Defined in src/index.ts:120
Load API asynchronously. The Promise is rejected with ApiLoadingError if the resulting Api contains errors and the 'rejectOnErrors' option is set to 'true'.

Parameters
- apiPath: string
  
  Path to API: local file system path or Web URL
- Optional options: Options
  
  Load options
Returns Promise<Api | Api>

Promise<Api>.
- Defined in src/index.ts:128
Load API asynchronously. The Promise is rejected with ApiLoadingError if the resulting Api contains errors and the 'rejectOnErrors' option is set to 'true'.

Parameters
- apiPath: string
  
  Path to API: local file system path or Web URL
- extensionsAndOverlays: string[]
  
  Paths to extensions and overlays to be applied listed in the order of application. Relevant for RAML 1.0 only.
- Optional options: Options
  
  Load options
Returns Promise<Api | Api>

Promise<Api>.

loadApiSync

loadApiSync(apiPath: string, options?: Options): Api | Api
loadApiSync(apiPath: string, extensionsAndOverlays: string[], options?: Options): Api | Api

- Defined in src/index.ts:23
Load API synchronously. If the 'rejectOnErrors' option is set to true, ApiLoadingError is thrown for Api which contains errors.

Parameters
- apiPath: string
  
  Path to API: local file system path or Web URL
- Optional options: Options
  
  Load options
Returns Api | Api

Api instance.
- Defined in src/index.ts:31
Load API synchronously. If the 'rejectOnErrors' option is set to true, ApiLoadingError is thrown for Api which contains errors.

Parameters
- apiPath: string
  
  Path to API: local file system path or Web URL
- extensionsAndOverlays: string[]
  
  Paths to extensions and overlays to be applied listed in the order of application. Relevant for RAML 1.0 only.
- Optional options: Options
  
  Load options
Returns Api | Api

Api instance.

loadRAML

loadRAML(ramlPath: string, extensionsAndOverlays: string[], options?: Options): Promise<BasicNode>

- Defined in src/index.ts:144
Load RAML asynchronously. May load both Api and Typed fragments. The Promise is rejected with ApiLoadingError if the resulting RAMLLanguageElement contains errors and the 'rejectOnErrors' option is set to 'true'.

Parameters
- ramlPath: string
  
  Path to RAML: local file system path or Web URL
- extensionsAndOverlays: string[]
  
  Paths to extensions and overlays to be applied listed in the order of application. Relevant for RAML 1.0 only.
- Optional options: Options
  
  Load options
Returns Promise<BasicNode>

Promise<RAMLLanguageElement>.

loadRAMLSync

loadRAMLSync(ramlPath: string, extensionsAndOverlays: string[], options?: Options): BasicNode

- Defined in src/index.ts:47
Load RAML synchronously. May load both Api and Typed fragments. If the 'rejectOnErrors' option is set to true, ApiLoadingError is thrown for RAML which contains errors.

Parameters
- ramlPath: string
  
  Path to RAML: local file system path or Web URL
- extensionsAndOverlays: string[]
  
  Paths to extensions and overlays to be applied listed in the order of application. Relevant for RAML 1.0 only.
- Optional options: Options
  
  Load options
Returns BasicNode

RAMLLanguageElement instance.

optionsForContent

optionsForContent(content: string, arg2?: Options, filePath?: any): Options

- Defined in src/index.ts:56
Parameters
- content: string
- Optional arg2: Options
- Optional filePath: any
Returns Options

parseRAML

parseRAML(content: string, arg2?: Options): Promise<BasicNode>

- Defined in src/index.ts:106
Load RAML asynchronously. May load both Api and Typed fragments. If the 'rejectOnErrors' option is set to true, ApiLoadingError is thrown for RAML which contains errors.

Parameters
- content: string
  
  content of the raml
- Optional arg2: Options
Returns Promise<BasicNode>

RAMLLanguageElement instance.

parseRAMLSync

parseRAMLSync(content: string, arg2?: Options): BasicNode

- Defined in src/index.ts:93
Load RAML synchronously. May load both Api and Typed fragments. If the 'rejectOnErrors' option is set to true, ApiLoadingError is thrown for RAML which contains errors.

Parameters
- content: string
  
  content of the raml
- Optional arg2: Options
Returns BasicNode

RAMLLanguageElement instance.

Index

Variables

Functions

Variables

PromiseConstructor

Functions

asFragment

Parameters

node: Api | Library | Overlay | Extension | Trait | TypeDeclaration | ResourceType | DocumentationItem

Returns FragmentDeclaration

getLanguageElementByRuntimeType

Parameters

runtimeType: ITypeDefinition

Returns BasicNode

isFragment

Parameters

node: Api | Library | Overlay | Extension | Trait | TypeDeclaration | ResourceType | DocumentationItem

Returns boolean

loadApi

Parameters

apiPath: string

Optional options: Options

Returns Promise<Api | Api>

Parameters

apiPath: string

extensionsAndOverlays: string[]

Optional options: Options

Returns Promise<Api | Api>

loadApiSync

Parameters

apiPath: string

Optional options: Options

Returns Api | Api

Parameters

apiPath: string

extensionsAndOverlays: string[]

Optional options: Options

Returns Api | Api

loadRAML

Parameters

ramlPath: string

extensionsAndOverlays: string[]

Optional options: Options

Returns Promise<BasicNode>

loadRAMLSync

Parameters

ramlPath: string

extensionsAndOverlays: string[]

Optional options: Options

Returns BasicNode

optionsForContent

Parameters

content: string

Optional arg2: Options

Optional filePath: any

Returns Options

parseRAML

Parameters

content: string

Optional arg2: Options

Returns Promise<BasicNode>

parseRAMLSync

Parameters

content: string

Optional arg2: Options

Returns BasicNode