External module "src/raml1/artifacts/raml08parser"

Index

Functions

Functions

getLanguageElementByRuntimeType

getLanguageElementByRuntimeType(runtimeType: ITypeDefinition): BasicNode

- Defined in src/raml1/artifacts/raml08parser.ts:3090
Gets AST node by runtime type, if runtime type matches any.

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

loadApi

loadApi(apiPath: string, options?: Options): Promise<Api>

- Defined in src/raml1/artifacts/raml08parser.ts:3073
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>

Promise<Api>.

loadApiSync

loadApiSync(apiPath: string, options?: Options): Api

- Defined in src/raml1/artifacts/raml08parser.ts:3054
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 instance.

loadRAML

loadRAML(ramlPath: string, arg1?: string[] | Options, arg2?: Options): Promise<BasicNode>

- Defined in src/raml1/artifacts/raml08parser.ts:3081
Parameters
- ramlPath: string
- Optional arg1: string[] | Options
- Optional arg2: Options
Returns Promise<BasicNode>

loadRAMLSync

loadRAMLSync(ramlPath: string, arg1?: string[] | Options, arg2?: Options): BasicNode

- Defined in src/raml1/artifacts/raml08parser.ts:3062
Parameters
- ramlPath: string
- Optional arg1: string[] | Options
- Optional arg2: Options
Returns BasicNode

Generated using TypeDoc