dots.typescript.watch-compiler-host

Liking cljdoc? Tell your friends :D

ClojureScript only.

after-program-create^cljs

(after-program-create watch-compiler-host program)

If provided, callback to invoke after every new program creation

Parameters:

program: T

Returns: void

If provided, callback to invoke after every new program creation

**Parameters:**
- `program`: `T`

**Returns:** `void`

source raw docstring

clear-timeout^cljs

(clear-timeout watch-compiler-host timeout-id)

If provided, will be used to reset existing delayed compilation

Parameters:

timeout-id: any

Returns: void

If provided, will be used to reset existing delayed compilation

**Parameters:**
- `timeout-id`: `any`

**Returns:** `void`

source raw docstring

create-hash^cljs

(create-hash watch-compiler-host data)

Parameters:

data: string

Returns: string

**Parameters:**
- `data`: `string`

**Returns:** `string`

source raw docstring

create-program^cljs

(create-program watch-compiler-host)

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

Returns: CreateProgram<T>

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

**Returns:** `CreateProgram<T>`

source raw docstring

current-directory^cljs

(current-directory watch-compiler-host)

Returns: string

**Returns:** `string`

source raw docstring

default-lib-file-name^cljs

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

Parameters:

options: CompilerOptions

Returns: string

**Parameters:**
- `options`: `CompilerOptions`

**Returns:** `string`

source raw docstring

default-lib-location^cljs

(default-lib-location watch-compiler-host)

Returns: string

**Returns:** `string`

source raw docstring

directories^cljs

(directories watch-compiler-host path)

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

Parameters:

path: string

Returns: string[]

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

**Parameters:**
- `path`: `string`

**Returns:** `string[]`

source raw docstring

directory-exists?^cljs

(directory-exists? watch-compiler-host path)

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

Parameters:

path: string

Returns: boolean

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

**Parameters:**
- `path`: `string`

**Returns:** `boolean`

source raw docstring

environment-variable^cljs

(environment-variable watch-compiler-host name)

If provided is used to get the environment variable

Parameters:

name: string

Returns: string | undefined

If provided is used to get the environment variable

**Parameters:**
- `name`: `string`

**Returns:** `string | undefined`

source raw docstring

file-exists?^cljs

(file-exists? watch-compiler-host 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

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`

source raw docstring

has-invalidated-resolutions?^cljs

(has-invalidated-resolutions? watch-compiler-host 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

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`

source raw docstring

js-doc-parsing-mode^cljs

(js-doc-parsing-mode watch-compiler-host)

Returns: JSDocParsingMode | undefined

**Returns:** `JSDocParsingMode | undefined`

source raw docstring

module-resolution-cache^cljs

(module-resolution-cache watch-compiler-host)

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 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`

source raw docstring

new-line^cljs

(new-line watch-compiler-host)

Returns: string

**Returns:** `string`

source raw docstring

on-watch-status-change^cljs

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

(on-watch-status-change watch-compiler-host
                        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

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`

source raw docstring

parsed-command-line^cljs

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

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

Parameters:

file-name: string

Returns: ParsedCommandLine | undefined

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

**Parameters:**
- `file-name`: `string`

**Returns:** `ParsedCommandLine | undefined`

source raw docstring

read-directory^cljs

(read-directory watch-compiler-host path)

(read-directory watch-compiler-host path extensions)

(read-directory watch-compiler-host path extensions exclude)

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

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

If provided, used to cache and handle directory structure modifications

Parameters:

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

Returns: string[]

If provided, used to cache and handle directory structure modifications

**Parameters:**
- `path`: `string`
- `extensions`: `readonly string[] | undefined`
- `exclude`: `readonly string[] | undefined`
- `include`: `readonly string[] | undefined`
- `depth`: `number | undefined`

**Returns:** `string[]`

source raw docstring

read-file^cljs

(read-file watch-compiler-host path)

(read-file watch-compiler-host 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

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`

source raw docstring

realpath^cljs

(realpath watch-compiler-host path)

Symbol links resolution

Parameters:

path: string

Returns: string

Symbol links resolution

**Parameters:**
- `path`: `string`

**Returns:** `string`

source raw docstring

resolve-module-name-literals^cljs

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

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

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

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

(resolve-module-name-literals watch-compiler-host
                              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[]

**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[]`

source raw docstring

resolve-module-names^cljs

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

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

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

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

(resolve-module-names watch-compiler-host
                      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)[]

**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)[]`

source raw docstring

resolve-type-reference-directive-references^cljs

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

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

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

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

(resolve-type-reference-directive-references watch-compiler-host
                                             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[]

**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[]`

source raw docstring

resolve-type-reference-directives^cljs

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

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

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

(resolve-type-reference-directives watch-compiler-host
                                   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)[]

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

**Returns:** `(ResolvedTypeReferenceDirective | undefined)[]`

source raw docstring

set-create-program!^cljs

(set-create-program! watch-compiler-host value)

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

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

source raw docstring

set-js-doc-parsing-mode!^cljs

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

source

set-timeout^cljs

(set-timeout watch-compiler-host 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

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`

source raw docstring

trace^cljs

(trace watch-compiler-host s)

If provided would be used to write log about compilation

Parameters:

s: string

Returns: void

If provided would be used to write log about compilation

**Parameters:**
- `s`: `string`

**Returns:** `void`

source raw docstring

use-case-sensitive-file-names?^cljs

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

Returns: boolean

**Returns:** `boolean`

source raw docstring

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

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

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

Returns: boolean

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

**Returns:** `boolean`

source raw docstring

watch-directory^cljs

(watch-directory watch-compiler-host path callback)

(watch-directory watch-compiler-host path callback recursive?)

(watch-directory watch-compiler-host 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

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`

source raw docstring

watch-file^cljs

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

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

(watch-file watch-compiler-host 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

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`

source raw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts

`Ctrl`+`k`	Jump to recent docs
`←`	Move to previous article
`→`	Move to next article
`Ctrl`+`/`	Jump to the search field

Raise an issue Browse cljdoc source Chat on Slack

× close