dots.typescript.watch-compiler-host-of-config-file — io.github.dots-cljs/dots-typescript 5.4.5-10

Host to create watch with config file

after-program-create cljs

(after-program-create watch-compiler-host-of-config-file program)

If provided, callback to invoke after every new program creation

Parameters:

• program: T

Returns: void

clear-timeout cljs

(clear-timeout watch-compiler-host-of-config-file timeout-id)

If provided, will be used to reset existing delayed compilation

Parameters:

• timeout-id: any

Returns: void

config-file-name cljs

(config-file-name watch-compiler-host-of-config-file)

Name of the config file to compile

Returns: string

create-hash cljs

(create-hash watch-compiler-host-of-config-file data)

Parameters:

• data: string

Returns: string

create-program cljs

(create-program watch-compiler-host-of-config-file)

Used to create the program when need for program creation or recreation detected

Returns: CreateProgram<T>

current-directory cljs

(current-directory watch-compiler-host-of-config-file)

Returns: string

default-lib-file-name cljs

(default-lib-file-name watch-compiler-host-of-config-file options)

Parameters:

• options: CompilerOptions

Returns: string

default-lib-location cljs

(default-lib-location watch-compiler-host-of-config-file)

Returns: string

directories cljs

(directories watch-compiler-host-of-config-file path)

If provided, used in resolutions as well as handling directory structure

Parameters:

• path: string

Returns: string[]

directory-exists? cljs

(directory-exists? watch-compiler-host-of-config-file path)

If provided, used for module resolution as well as to handle directory structure

Parameters:

• path: string

Returns: boolean

environment-variable cljs

(environment-variable watch-compiler-host-of-config-file name)

If provided is used to get the environment variable

Parameters:

• name: string

Returns: string | undefined

extra-file-extensions cljs

(extra-file-extensions watch-compiler-host-of-config-file)

Returns: readonly FileExtensionInfo[] | undefined

file-exists? cljs

(file-exists? watch-compiler-host-of-config-file path)

Use to check file presence for source files and if resolveModuleNames is not provided (complier is in charge of module resolution) then module files as well

Parameters:

• path: string

Returns: boolean

has-invalidated-resolutions? cljs

(has-invalidated-resolutions? watch-compiler-host-of-config-file file-path)

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

Parameters:

• file-path: Path

Returns: boolean

js-doc-parsing-mode cljs

(js-doc-parsing-mode watch-compiler-host-of-config-file)

Returns: JSDocParsingMode | undefined

module-resolution-cache cljs

(module-resolution-cache watch-compiler-host-of-config-file)

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

new-line cljs

(new-line watch-compiler-host-of-config-file)

Returns: string

on-un-recoverable-config-file-diagnostic cljs

(on-un-recoverable-config-file-diagnostic watch-compiler-host-of-config-file)

Reports unrecoverable error when parsing config file

Returns: DiagnosticReporter

on-watch-status-change cljs

(on-watch-status-change watch-compiler-host-of-config-file
                        diagnostic
                        new-line
                        options)

(on-watch-status-change watch-compiler-host-of-config-file
                        diagnostic
                        new-line
                        options
                        error-count)

If provided, called with Diagnostic message that informs about change in watch status

Parameters:

• diagnostic: Diagnostic
• new-line: string
• options: CompilerOptions
• error-count: number | undefined

Returns: void

options-to-extend cljs

(options-to-extend watch-compiler-host-of-config-file)

Options to extend

Returns: CompilerOptions | undefined

parsed-command-line cljs

(parsed-command-line watch-compiler-host-of-config-file file-name)

If provided, use this method to get parsed command lines for referenced projects

Parameters:

• file-name: string

Returns: ParsedCommandLine | undefined

read-directory cljs

(read-directory watch-compiler-host-of-config-file path)

(read-directory watch-compiler-host-of-config-file path extensions)

(read-directory watch-compiler-host-of-config-file path extensions exclude)

(read-directory watch-compiler-host-of-config-file
                path
                extensions
                exclude
                include)

(read-directory watch-compiler-host-of-config-file
                path
                extensions
                exclude
                include
                depth)

Used to generate source file names from the config file and its include, exclude, files rules and also to cache the directory stucture

Parameters:

• path: string
• extensions: readonly string[] | undefined
• exclude: readonly string[] | undefined
• include: readonly string[] | undefined
• depth: number | undefined

Returns: string[]

read-file cljs

(read-file watch-compiler-host-of-config-file path)

(read-file watch-compiler-host-of-config-file path encoding)

Use to read file text for source files and if resolveModuleNames is not provided (complier is in charge of module resolution) then module files as well

Parameters:

• path: string
• encoding: string | undefined

Returns: string | undefined

realpath cljs

(realpath watch-compiler-host-of-config-file path)

Symbol links resolution

Parameters:

• path: string

Returns: string

resolve-module-name-literals cljs

(resolve-module-name-literals watch-compiler-host-of-config-file
                              module-literals
                              containing-file)

(resolve-module-name-literals watch-compiler-host-of-config-file
                              module-literals
                              containing-file
                              redirected-reference)

(resolve-module-name-literals watch-compiler-host-of-config-file
                              module-literals
                              containing-file
                              redirected-reference
                              options)

(resolve-module-name-literals watch-compiler-host-of-config-file
                              module-literals
                              containing-file
                              redirected-reference
                              options
                              containing-source-file)

(resolve-module-name-literals watch-compiler-host-of-config-file
                              module-literals
                              containing-file
                              redirected-reference
                              options
                              containing-source-file
                              reused-names)

Parameters:

• module-literals: readonly StringLiteralLike[]
• containing-file: string
• redirected-reference: ResolvedProjectReference | undefined
• options: CompilerOptions
• containing-source-file: SourceFile
• reused-names: readonly StringLiteralLike[] | undefined

Returns: readonly ResolvedModuleWithFailedLookupLocations[]

resolve-module-names cljs

(resolve-module-names watch-compiler-host-of-config-file
                      module-names
                      containing-file)

(resolve-module-names watch-compiler-host-of-config-file
                      module-names
                      containing-file
                      reused-names)

(resolve-module-names watch-compiler-host-of-config-file
                      module-names
                      containing-file
                      reused-names
                      redirected-reference)

(resolve-module-names watch-compiler-host-of-config-file
                      module-names
                      containing-file
                      reused-names
                      redirected-reference
                      options)

(resolve-module-names watch-compiler-host-of-config-file
                      module-names
                      containing-file
                      reused-names
                      redirected-reference
                      options
                      containing-source-file)

Parameters:

• module-names: string[]
• containing-file: string
• reused-names: string[] | undefined
• redirected-reference: ResolvedProjectReference | undefined
• options: CompilerOptions
• containing-source-file: SourceFile | undefined

Returns: (ResolvedModule | undefined)[]

resolve-type-reference-directive-references cljs

(resolve-type-reference-directive-references watch-compiler-host-of-config-file
                                             type-directive-references
                                             containing-file)

(resolve-type-reference-directive-references watch-compiler-host-of-config-file
                                             type-directive-references
                                             containing-file
                                             redirected-reference)

(resolve-type-reference-directive-references watch-compiler-host-of-config-file
                                             type-directive-references
                                             containing-file
                                             redirected-reference
                                             options)

(resolve-type-reference-directive-references watch-compiler-host-of-config-file
                                             type-directive-references
                                             containing-file
                                             redirected-reference
                                             options
                                             containing-source-file)

(resolve-type-reference-directive-references watch-compiler-host-of-config-file
                                             type-directive-references
                                             containing-file
                                             redirected-reference
                                             options
                                             containing-source-file
                                             reused-names)

Parameters:

• type-directive-references: readonly T[]
• containing-file: string
• redirected-reference: ResolvedProjectReference | undefined
• options: CompilerOptions
• containing-source-file: SourceFile | undefined
• reused-names: readonly T[] | undefined

Returns: readonly ResolvedTypeReferenceDirectiveWithFailedLookupLocations[]

resolve-type-reference-directives cljs

(resolve-type-reference-directives watch-compiler-host-of-config-file
                                   type-reference-directive-names
                                   containing-file)

(resolve-type-reference-directives watch-compiler-host-of-config-file
                                   type-reference-directive-names
                                   containing-file
                                   redirected-reference)

(resolve-type-reference-directives watch-compiler-host-of-config-file
                                   type-reference-directive-names
                                   containing-file
                                   redirected-reference
                                   options)

(resolve-type-reference-directives watch-compiler-host-of-config-file
                                   type-reference-directive-names
                                   containing-file
                                   redirected-reference
                                   options
                                   containing-file-mode)

Parameters:

• type-reference-directive-names: string[] | readonly FileReference[]
• containing-file: string
• redirected-reference: ResolvedProjectReference | undefined
• options: CompilerOptions
• containing-file-mode: ResolutionMode

Returns: (ResolvedTypeReferenceDirective | undefined)[]

set-config-file-name! cljs

(set-config-file-name! watch-compiler-host-of-config-file value)

Name of the config file to compile

set-create-program! cljs

(set-create-program! watch-compiler-host-of-config-file value)

Used to create the program when need for program creation or recreation detected

set-extra-file-extensions! cljs

(set-extra-file-extensions! watch-compiler-host-of-config-file value)

set-js-doc-parsing-mode! cljs

(set-js-doc-parsing-mode! watch-compiler-host-of-config-file value)

set-on-un-recoverable-config-file-diagnostic! cljs

(set-on-un-recoverable-config-file-diagnostic!
  watch-compiler-host-of-config-file
  value)

Reports unrecoverable error when parsing config file

set-options-to-extend! cljs

(set-options-to-extend! watch-compiler-host-of-config-file value)

Options to extend

set-timeout cljs

(set-timeout watch-compiler-host-of-config-file callback ms & args)

If provided, will be used to set delayed compilation, so that multiple changes in short span are compiled together

Parameters:

• callback: (...args: any[]) => void
• ms: number
• args: any[]

Returns: any

set-watch-options-to-extend! cljs

(set-watch-options-to-extend! watch-compiler-host-of-config-file value)

trace cljs

(trace watch-compiler-host-of-config-file s)

If provided would be used to write log about compilation

Parameters:

• s: string

Returns: void

use-case-sensitive-file-names? cljs

(use-case-sensitive-file-names? watch-compiler-host-of-config-file)

Returns: boolean

use-source-of-project-reference-redirect? cljs

(use-source-of-project-reference-redirect? watch-compiler-host-of-config-file)

Instead of using output d.ts file from project reference, use its source file

Returns: boolean

watch-directory cljs

(watch-directory watch-compiler-host-of-config-file path callback)

(watch-directory watch-compiler-host-of-config-file path callback recursive?)

(watch-directory watch-compiler-host-of-config-file
                 path
                 callback
                 recursive?
                 options)

Used to watch resolved module's failed lookup locations, config file specs, type roots where auto type reference directives are added

Parameters:

• path: string
• callback: DirectoryWatcherCallback
• recursive?: boolean | undefined
• options: WatchOptions | undefined

Returns: FileWatcher

watch-file cljs

(watch-file watch-compiler-host-of-config-file path callback)

(watch-file watch-compiler-host-of-config-file path callback polling-interval)

(watch-file watch-compiler-host-of-config-file
            path
            callback
            polling-interval
            options)

Used to watch changes in source files, missing files needed to update the program or config file

Parameters:

• path: string
• callback: FileWatcherCallback
• polling-interval: number | undefined
• options: WatchOptions | undefined

Returns: FileWatcher

watch-options-to-extend cljs

(watch-options-to-extend watch-compiler-host-of-config-file)

Returns: WatchOptions | undefined