banira
    Preparing search index...

    Interface VirtualCompilerHost

    Extended TypeScript CompilerHost that includes a virtual filesystem

    VirtualCompilerHost

    interface VirtualCompilerHost {
        jsDocParsingMode?: JSDocParsingMode;
        volume: Volume;
        writeFile: WriteFileCallback;
        createHash?(data: string): string;
        directoryExists?(directoryName: string): boolean;
        fileExists(fileName: string): boolean;
        getCancellationToken?(): CancellationToken;
        getCanonicalFileName(fileName: string): string;
        getCurrentDirectory(): string;
        getDefaultLibFileName(options: CompilerOptions): string;
        getDefaultLibLocation?(): string;
        getDirectories?(path: string): string[];
        getEnvironmentVariable?(name: string): string | undefined;
        getModuleResolutionCache?(): ModuleResolutionCache | undefined;
        getNewLine(): string;
        getParsedCommandLine?(fileName: string): ParsedCommandLine | undefined;
        getSourceFile(
            fileName: string,
            languageVersionOrOptions: ScriptTarget | CreateSourceFileOptions,
            onError?: (message: string) => void,
            shouldCreateNewSourceFile?: boolean,
        ): SourceFile | undefined;
        getSourceFileByPath?(
            fileName: string,
            path: Path,
            languageVersionOrOptions: ScriptTarget | CreateSourceFileOptions,
            onError?: (message: string) => void,
            shouldCreateNewSourceFile?: boolean,
        ): SourceFile | undefined;
        hasInvalidatedResolutions?(filePath: Path): boolean;
        readDirectory?(
            rootDir: string,
            extensions: readonly string[],
            excludes: readonly string[] | undefined,
            includes: readonly string[],
            depth?: number,
        ): string[];
        readFile(fileName: string): string | undefined;
        realpath?(path: string): string;
        resolveModuleNameLiterals?(
            moduleLiterals: readonly StringLiteralLike[],
            containingFile: string,
            redirectedReference: ResolvedProjectReference | undefined,
            options: CompilerOptions,
            containingSourceFile: SourceFile,
            reusedNames: readonly StringLiteralLike[] | undefined,
        ): readonly ResolvedModuleWithFailedLookupLocations[];
        resolveModuleNames?(
            moduleNames: string[],
            containingFile: string,
            reusedNames: string[] | undefined,
            redirectedReference: ResolvedProjectReference | undefined,
            options: CompilerOptions,
            containingSourceFile?: SourceFile,
        ): (ResolvedModule | undefined)[];
        resolveTypeReferenceDirectiveReferences?<T extends string | FileReference>(
            typeDirectiveReferences: readonly T[],
            containingFile: string,
            redirectedReference: ResolvedProjectReference | undefined,
            options: CompilerOptions,
            containingSourceFile: SourceFile | undefined,
            reusedNames: readonly T[] | undefined,
        ): readonly ResolvedTypeReferenceDirectiveWithFailedLookupLocations[];
        resolveTypeReferenceDirectives?(
            typeReferenceDirectiveNames: string[] | readonly FileReference[],
            containingFile: string,
            redirectedReference: ResolvedProjectReference | undefined,
            options: CompilerOptions,
            containingFileMode?: ResolutionMode,
        ): (ResolvedTypeReferenceDirective | undefined)[];
        trace?(s: string): void;
        useCaseSensitiveFileNames(): boolean;
    }

    Hierarchy

    • CompilerHost
      • VirtualCompilerHost
    Index

    Properties

    jsDocParsingMode? volume writeFile

    Methods

    createHash? directoryExists? fileExists getCancellationToken? getCanonicalFileName getCurrentDirectory getDefaultLibFileName getDefaultLibLocation? getDirectories? getEnvironmentVariable? getModuleResolutionCache? getNewLine getParsedCommandLine? getSourceFile getSourceFileByPath? hasInvalidatedResolutions? readDirectory? readFile realpath? resolveModuleNameLiterals? resolveModuleNames? resolveTypeReferenceDirectiveReferences? resolveTypeReferenceDirectives? trace? useCaseSensitiveFileNames

    Properties

    jsDocParsingMode?: JSDocParsingMode
    volume: Volume

    The memfs Volume instance representing the virtual filesystem

    writeFile: WriteFileCallback

    Methods

    • Parameters

      • data: string

      Returns string

    • Parameters

      • directoryName: string

      Returns boolean

    • Parameters

      • fileName: string

      Returns boolean

    • Returns CancellationToken

    • Parameters

      • fileName: string

      Returns string

    • Returns string

    • Parameters

      • options: CompilerOptions

      Returns string

    • Returns string

    • Parameters

      • path: string

      Returns string[]

    • Parameters

      • name: string

      Returns string | undefined

    • Returns the module resolution cache used by a provided resolveModuleNames implementation so that any non-name module resolution operations (eg, package.json lookup) can reuse it

      Returns ModuleResolutionCache | undefined

    • Returns string

    • Parameters

      • fileName: string

      Returns ParsedCommandLine | undefined

    • Parameters

      • fileName: string
      • languageVersionOrOptions: ScriptTarget | CreateSourceFileOptions
      • OptionalonError: (message: string) => void
      • OptionalshouldCreateNewSourceFile: boolean

      Returns SourceFile | undefined

    • Parameters

      • fileName: string
      • path: Path
      • languageVersionOrOptions: ScriptTarget | CreateSourceFileOptions
      • OptionalonError: (message: string) => void
      • OptionalshouldCreateNewSourceFile: boolean

      Returns SourceFile | undefined

    • If provided along with custom resolveModuleNames or resolveTypeReferenceDirectives, used to determine if unchanged file path needs to re-resolve modules/type reference directives

      Parameters

      • filePath: Path

      Returns boolean

    • Parameters

      • rootDir: string
      • extensions: readonly string[]
      • excludes: readonly string[] | undefined
      • includes: readonly string[]
      • Optionaldepth: number

      Returns string[]

    • Parameters

      • fileName: string

      Returns string | undefined

    • Parameters

      • moduleLiterals: readonly StringLiteralLike[]
      • containingFile: string
      • redirectedReference: ResolvedProjectReference | undefined
      • options: CompilerOptions
      • containingSourceFile: SourceFile
      • reusedNames: readonly StringLiteralLike[] | undefined

      Returns readonly ResolvedModuleWithFailedLookupLocations[]

    • Parameters

      • moduleNames: string[]
      • containingFile: string
      • reusedNames: string[] | undefined
      • redirectedReference: ResolvedProjectReference | undefined
      • options: CompilerOptions
      • OptionalcontainingSourceFile: SourceFile

      Returns (ResolvedModule | undefined)[]

      supply resolveModuleNameLiterals instead for resolution that can handle newer resolution modes like nodenext

    • Type Parameters

      • T extends string | FileReference

      Parameters

      • typeDirectiveReferences: readonly T[]
      • containingFile: string
      • redirectedReference: ResolvedProjectReference | undefined
      • options: CompilerOptions
      • containingSourceFile: SourceFile | undefined
      • reusedNames: readonly T[] | undefined

      Returns readonly ResolvedTypeReferenceDirectiveWithFailedLookupLocations[]

    • Parameters

      • typeReferenceDirectiveNames: string[] | readonly FileReference[]
      • containingFile: string
      • redirectedReference: ResolvedProjectReference | undefined
      • options: CompilerOptions
      • OptionalcontainingFileMode: ResolutionMode

      Returns (ResolvedTypeReferenceDirective | undefined)[]

      supply resolveTypeReferenceDirectiveReferences instead for resolution that can handle newer resolution modes like nodenext

      This method is a companion for 'resolveModuleNames' and is used to resolve 'types' references to actual type declaration files

    • Parameters

      • s: string

      Returns void

    • Returns boolean

    Settings

    Member Visibility

    On This Page

    Properties
    Methods