typescript-docs-verifier/dist/src/SnippetCompiler.d.ts

Verifies that typescript examples in markdown files actually compile.

import * as TSNode from "ts-node";
import { PackageDefinition } from "./PackageInfo";
export type SnippetCompilationResult = {
    readonly file: string;
    readonly index: number;
    readonly snippet: string;
    readonly linesWithErrors: number[];
    readonly error?: TSNode.TSError | Error;
};
export declare class SnippetCompiler {
    private readonly workingDirectory;
    private readonly packageDefinition;
    private readonly compilerConfig;
    constructor(workingDirectory: string, packageDefinition: PackageDefinition, project?: string);
    private static loadTypeScriptConfig;
    private static escapeRegExp;
    compileSnippets(documentationFiles: string[]): Promise<SnippetCompilationResult[]>;
    private cleanWorkingDirectory;
    private extractAllCodeBlocks;
    private extractFileCodeBlocks;
    private sanitiseCodeBlock;
    private compile;
    private removeTemporaryFilePaths;
    private testCodeCompilation;
}