External module "src/raml1/apiLoader"

Index

Type aliases

Functions

Type aliases

IHighLevelNode

IHighLevelNode: IHighLevelNode

IParseResult

IParseResult: IParseResult

Functions

fetchAndLoadApiAsync

fetchAndLoadApiAsync(project: Project, unitName: string, options: Options): Promise<any>

- Defined in src/raml1/apiLoader.ts:221
Parameters
- project: Project
- unitName: string
- options: Options
Returns Promise<any>

getLanguageElementByRuntimeType

getLanguageElementByRuntimeType(runtimeType: ITypeDefinition): BasicNode

- Defined in src/raml1/apiLoader.ts:208
Gets AST node by runtime type, if runtime type matches any.

Parameters
- runtimeType: ITypeDefinition
Returns BasicNode

getProject

getProject(apiPath: string, options?: Options): Project

- Defined in src/raml1/apiLoader.ts:236
Parameters
- apiPath: string
- Optional options: Options
Returns Project

loadApi

loadApi(apiPath: string, arg1?: string[] | Options, arg2?: string[] | Options): Opt<Api | Api>

- Defined in src/raml1/apiLoader.ts:35
Load API synchronously. Detects RAML version and uses corresponding parser.

Parameters
- apiPath: string
  
  Path to API: local file system path or Web URL
- Optional arg1: string[] | Options
- Optional arg2: string[] | Options
Returns Opt<Api | Api>

Opt<Api>, where Api belongs to RAML 1.0 or RAML 0.8 model.

loadApiAsync

loadApiAsync(apiPath: string, arg1?: string[] | Options, arg2?: string[] | Options): Promise<Api | Api>

- Defined in src/raml1/apiLoader.ts:125
Load API asynchronously. Detects RAML version and uses corresponding parser.

Parameters
- apiPath: string
  
  Path to API: local file system path or Web URL
- Optional arg1: string[] | Options
- Optional arg2: string[] | Options
Returns Promise<Api | Api>

Promise<Api>, where Api belongs to RAML 1.0 or RAML 0.8 model.

loadApis1

loadApis1(projectRoot: string, cacheChildren?: boolean, expandTraitsAndResourceTypes?: boolean): Array<Api>

- Defined in src/raml1/apiLoader.ts:328
Parameters
- projectRoot: string
- Default value cacheChildren: boolean = false
- Default value expandTraitsAndResourceTypes: boolean = true
Returns Array<Api>

loadRAML

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

- Defined in src/raml1/apiLoader.ts:54
Load RAML synchronously. Detects RAML version and uses corresponding parser.

Parameters
- ramlPath: string
  
  Path to RAML: local file system path or Web URL
- Optional arg1: string[] | Options
- Optional arg2: string[] | Options
Returns Opt<BasicNode>

Opt<RAMLLanguageElement>, where RAMLLanguageElement belongs to RAML 1.0 or RAML 0.8 model.

loadRAMLAsync

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

- Defined in src/raml1/apiLoader.ts:143
Load API asynchronously. Detects RAML version and uses corresponding parser.

Parameters
- ramlPath: string
  
  Path to RAML: local file system path or Web URL
- Optional arg1: string[] | Options
- Optional arg2: string[] | Options
Returns Promise<BasicNode>

Promise<RAMLLanguageElement>, where RAMLLanguageElement belongs to RAML 1.0 or RAML 0.8 model.

loadRAMLInternal

loadRAMLInternal(apiPath: string, arg1?: string[] | Options, arg2?: string[] | Options): BasicNode

- Defined in src/raml1/apiLoader.ts:59
Parameters
- apiPath: string
- Optional arg1: string[] | Options
- Optional arg2: string[] | Options
Returns BasicNode

toApi

toApi(unitOrHighlevel: ICompilationUnit | IHighLevelNode, options: Options, checkApisOverlays?: boolean): BasicNode

- Defined in src/raml1/apiLoader.ts:247
Parameters
- unitOrHighlevel: ICompilationUnit | IHighLevelNode
- options: Options
- Default value checkApisOverlays: boolean = false
Returns BasicNode

toError

toError(api: BasicNode): ApiLoadingError

- Defined in src/raml1/apiLoader.ts:321
Parameters
- api: BasicNode
Returns ApiLoadingError

Generated using TypeDoc