rush-stack-compiler-2.9.api.md

API Report File for "@microsoft/rush-stack-compiler-2.9"

Do not edit this file. It is a report generated by API Extractor.

import * as ApiExtractor from '@microsoft/api-extractor';
import { ExtractorConfig } from '@microsoft/api-extractor';
import { IExtractorInvokeOptions } from '@microsoft/api-extractor';
import { IPackageJson } from '@microsoft/node-core-library';
import { ITerminalProvider } from '@microsoft/node-core-library';
import { Terminal } from '@microsoft/node-core-library';
import * as Tslint from 'tslint';
import * as Typescript from 'typescript';

// @beta
export class ApiExtractorRunner extends RushStackCompilerBase {
    constructor(extractorConfig: ExtractorConfig, extractorOptions: IExtractorInvokeOptions, rootPath: string, terminalProvider: ITerminalProvider);
    constructor(options: IRushStackCompilerBaseOptions, extractorConfig: ExtractorConfig, extractorOptions: IExtractorInvokeOptions, rootPath: string, terminalProvider: ITerminalProvider);
    // (undocumented)
    static apiExtractor: typeof ApiExtractor;
    // (undocumented)
    invoke(): Promise<void>;
}

// @public (undocumented)
export interface IRushStackCompilerBaseOptions {
    // (undocumented)
    fileError: WriteFileIssueFunction;
    // (undocumented)
    fileWarning: WriteFileIssueFunction;
}

// @public (undocumented)
export interface ITslintRunnerConfig extends IRushStackCompilerBaseOptions {
    displayAsError?: boolean;
}

// @beta (undocumented)
export interface ITypescriptCompilerOptions extends IRushStackCompilerBaseOptions {
    customArgs?: string[];
}

// @beta (undocumented)
export abstract class RushStackCompilerBase<TOptions extends IRushStackCompilerBaseOptions = IRushStackCompilerBaseOptions> {
    constructor(taskOptions: TOptions, rootPath: string, terminalProvider: ITerminalProvider);
    // (undocumented)
    protected _fileError: WriteFileIssueFunction;
    // (undocumented)
    protected _fileWarning: WriteFileIssueFunction;
    // (undocumented)
    protected _standardBuildFolders: StandardBuildFolders;
    // (undocumented)
    protected _taskOptions: TOptions;
    // (undocumented)
    protected _terminal: Terminal;
}

// @beta (undocumented)
export class StandardBuildFolders {
    constructor(projectFolderPath: string);
    // (undocumented)
    readonly distFolderPath: string;
    // (undocumented)
    readonly libFolderPath: string;
    // (undocumented)
    readonly projectFolderPath: string;
    // (undocumented)
    readonly srcFolderPath: string;
    // (undocumented)
    readonly tempFolderPath: string;
    }

// @alpha (undocumented)
export class ToolPackages {
    // (undocumented)
    static apiExtractor: typeof ApiExtractor;
    // (undocumented)
    static tslint: typeof Tslint;
    // (undocumented)
    static typescript: typeof Typescript;
}

// @beta (undocumented)
export class ToolPaths {
    // (undocumented)
    static readonly tslintPackageJson: IPackageJson;
    // (undocumented)
    static readonly tslintPackagePath: string;
    // (undocumented)
    static readonly typescriptPackageJson: IPackageJson;
    // (undocumented)
    static readonly typescriptPackagePath: string;
    }

// @beta (undocumented)
export class TslintRunner extends RushStackCompilerBase<ITslintRunnerConfig> {
    constructor(taskOptions: ITslintRunnerConfig, rootPath: string, terminalProvider: ITerminalProvider);
    // (undocumented)
    invoke(): Promise<void>;
}

// @beta (undocumented)
export class TypescriptCompiler extends RushStackCompilerBase<ITypescriptCompilerOptions> {
    constructor(rootPath: string, terminalProvider: ITerminalProvider);
    constructor(taskOptions: ITypescriptCompilerOptions, rootPath: string, terminalProvider: ITerminalProvider);
    // (undocumented)
    invoke(): Promise<void>;
}

// @public (undocumented)
export type WriteFileIssueFunction = (filePath: string, line: number, column: number, errorCode: string, message: string) => void;