@microsoft/api-extractor/lib/generators/dtsRollup/AstImport.d.ts

Validate, document, and review the exported API for a TypeScript library

/**
 * Constructor parameters for AstImport
 */
export interface IAstImportParameters {
    readonly modulePath: string;
    readonly exportName: string;
}
/**
 * For a symbol that was imported from an external package, this tracks the import
 * statement that was used to reach it.
 */
export declare class AstImport {
    /**
     * The name of the external package (and possibly module path) that this definition
     * was imported from.  If it was defined in the referencing source file, or if it was
     * imported from a local file, or if it is an ambient definition, then externalPackageName
     * will be undefined.
     *
     * Example: "@microsoft/gulp-core-build/lib/IBuildConfig"
     */
    readonly modulePath: string;
    /**
     * If importPackagePath is defined, then this specifies the export name for the definition.
     *
     * Example: "IBuildConfig"
     */
    readonly exportName: string;
    /**
     * If importPackagePath and importPackageExportName are defined, then this is a dictionary key
     * that combines them with a colon (":").
     *
     * Example: "@microsoft/gulp-core-build/lib/IBuildConfig:IBuildConfig"
     */
    readonly key: string;
    constructor(parameters: IAstImportParameters);
}