Liking cljdoc? Tell your friends :D

dots.typescript.watch-compiler-host


after-program-createcljs

(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`
sourceraw docstring

clear-timeoutcljs

(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`
sourceraw docstring

create-hashcljs

(create-hash watch-compiler-host data)

Parameters:

  • data: string

Returns: string

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

**Returns:** `string`
sourceraw docstring

create-programcljs

(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>`
sourceraw docstring

current-directorycljs

(current-directory watch-compiler-host)

Returns: string

**Returns:** `string`
sourceraw docstring

default-lib-file-namecljs

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

Parameters:

  • options: CompilerOptions

Returns: string

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

**Returns:** `string`
sourceraw docstring

default-lib-locationcljs

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

Returns: string

**Returns:** `string`
sourceraw docstring

directoriescljs

(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[]`
sourceraw 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`
sourceraw docstring

environment-variablecljs

(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`
sourceraw 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`
sourceraw 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`
sourceraw docstring

js-doc-parsing-modecljs

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

Returns: JSDocParsingMode | undefined

**Returns:** `JSDocParsingMode | undefined`
sourceraw docstring

module-resolution-cachecljs

(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`
sourceraw docstring

new-linecljs

(new-line watch-compiler-host)

Returns: string

**Returns:** `string`
sourceraw docstring

on-watch-status-changecljs

(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`
sourceraw docstring

parsed-command-linecljs

(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`
sourceraw docstring

read-directorycljs

(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[]`
sourceraw docstring

read-filecljs

(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`
sourceraw docstring

realpathcljs

(realpath watch-compiler-host path)

Symbol links resolution

Parameters:

  • path: string

Returns: string

Symbol links resolution

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

**Returns:** `string`
sourceraw docstring

resolve-module-name-literalscljs

(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[]`
sourceraw docstring

resolve-module-namescljs

(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)[]`
sourceraw docstring

resolve-type-reference-directive-referencescljs

(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[]`
sourceraw docstring

resolve-type-reference-directivescljs

(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)[]`
sourceraw 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
sourceraw docstring

set-js-doc-parsing-mode!cljs

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

set-timeoutcljs

(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`
sourceraw docstring

tracecljs

(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`
sourceraw docstring

use-case-sensitive-file-names?cljs

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

Returns: boolean

**Returns:** `boolean`
sourceraw 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`
sourceraw docstring

watch-directorycljs

(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`
sourceraw docstring

watch-filecljs

(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`
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close