@bitjson/typedoc/dist/lib/converter/converter.d.ts

Create api documentation for TypeScript projects.

import * as ts from 'typescript';
import { Application } from '../application';
import { Reflection, Type, ProjectReflection } from '../models/index';
import { Context } from './context';
import { ConverterComponent } from './components';
import { Component, ChildableComponent, ComponentClass } from '../utils/component';
export interface ConverterResult {
    errors: ReadonlyArray<ts.Diagnostic>;
    project: ProjectReflection;
}
export declare class Converter extends ChildableComponent<Application, ConverterComponent> {
    name: string;
    externalPattern: Array<string>;
    includeDeclarations: boolean;
    excludeExternals: boolean;
    excludeNotExported: boolean;
    excludePrivate: boolean;
    excludeProtected: boolean;
    private nodeConverters;
    private typeNodeConverters;
    private typeTypeConverters;
    static EVENT_BEGIN: string;
    static EVENT_END: string;
    static EVENT_FILE_BEGIN: string;
    static EVENT_CREATE_DECLARATION: string;
    static EVENT_CREATE_SIGNATURE: string;
    static EVENT_CREATE_PARAMETER: string;
    static EVENT_CREATE_TYPE_PARAMETER: string;
    static EVENT_FUNCTION_IMPLEMENTATION: string;
    static EVENT_RESOLVE_BEGIN: string;
    static EVENT_RESOLVE: string;
    static EVENT_RESOLVE_END: string;
    initialize(): void;
    addComponent<T extends ConverterComponent & Component>(name: string, componentClass: T | ComponentClass<T>): T;
    private addNodeConverter;
    private addTypeConverter;
    removeComponent(name: string): ConverterComponent | undefined;
    private removeNodeConverter;
    private removeTypeConverter;
    removeAllComponents(): void;
    convert(fileNames: string[]): ConverterResult;
    convertNode(context: Context, node: ts.Node): Reflection | undefined;
    convertType(context: Context, node?: ts.Node, type?: ts.Type): Type | undefined;
    convertTypes(context: Context, nodes?: ReadonlyArray<ts.Node>, types?: ReadonlyArray<ts.Type>): Type[];
    private compile;
    private resolve;
    getDefaultLib(): string;
}