UNPKG

2.09 kBTypeScriptView Raw
1import * as ts from 'typescript';
2import { Application } from '../application';
3import { Reflection, Type, ProjectReflection } from '../models/index';
4import { Context } from './context';
5import { ConverterComponent } from './components';
6import { Component, ChildableComponent, ComponentClass } from '../utils/component';
7export interface ConverterResult {
8 errors: ReadonlyArray<ts.Diagnostic>;
9 project: ProjectReflection;
10}
11export declare class Converter extends ChildableComponent<Application, ConverterComponent> {
12 name: string;
13 externalPattern: Array<string>;
14 includeDeclarations: boolean;
15 excludeExternals: boolean;
16 excludeNotExported: boolean;
17 excludeNotDocumented: boolean;
18 excludePrivate: boolean;
19 excludeProtected: boolean;
20 private nodeConverters;
21 private typeNodeConverters;
22 private typeTypeConverters;
23 static EVENT_BEGIN: string;
24 static EVENT_END: string;
25 static EVENT_FILE_BEGIN: string;
26 static EVENT_CREATE_DECLARATION: string;
27 static EVENT_CREATE_SIGNATURE: string;
28 static EVENT_CREATE_PARAMETER: string;
29 static EVENT_CREATE_TYPE_PARAMETER: string;
30 static EVENT_FUNCTION_IMPLEMENTATION: string;
31 static EVENT_RESOLVE_BEGIN: string;
32 static EVENT_RESOLVE: string;
33 static EVENT_RESOLVE_END: string;
34 initialize(): void;
35 addComponent<T extends ConverterComponent & Component>(name: string, componentClass: T | ComponentClass<T>): T;
36 private addNodeConverter;
37 private addTypeConverter;
38 removeComponent(name: string): ConverterComponent | undefined;
39 private removeNodeConverter;
40 private removeTypeConverter;
41 removeAllComponents(): void;
42 convert(fileNames: string[]): ConverterResult;
43 convertNode(context: Context, node: ts.Node): Reflection | undefined;
44 convertType(context: Context, node?: ts.Node, type?: ts.Type): Type | undefined;
45 convertTypes(context: Context, nodes?: ReadonlyArray<ts.Node>, types?: ReadonlyArray<ts.Type>): Type[];
46 private compile;
47 private resolve;
48 private getCompilerErrors;
49 getDefaultLib(): string;
50}