Liking cljdoc? Tell your friends :D

dots.typescript.watch-compiler-host-of-files-and-compiler-options

Host to create watch with root files and options

Host to create watch with root files and options
raw docstring

after-program-createcljs

(after-program-create watch-compiler-host-of-files-and-compiler-options 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-of-files-and-compiler-options 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-of-files-and-compiler-options data)

Parameters:

  • data: string

Returns: string

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

**Returns:** `string`
sourceraw docstring

create-programcljs

(create-program watch-compiler-host-of-files-and-compiler-options)

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-of-files-and-compiler-options)

Returns: string

**Returns:** `string`
sourceraw docstring

default-lib-file-namecljs

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

Parameters:

  • options: CompilerOptions

Returns: string

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

**Returns:** `string`
sourceraw docstring

default-lib-locationcljs

(default-lib-location watch-compiler-host-of-files-and-compiler-options)

Returns: string

**Returns:** `string`
sourceraw docstring

directoriescljs

(directories watch-compiler-host-of-files-and-compiler-options 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-of-files-and-compiler-options 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-of-files-and-compiler-options 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-of-files-and-compiler-options 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-of-files-and-compiler-options
                              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-of-files-and-compiler-options)

Returns: JSDocParsingMode | undefined

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

module-resolution-cachecljs

(module-resolution-cache watch-compiler-host-of-files-and-compiler-options)

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-of-files-and-compiler-options)

Returns: string

**Returns:** `string`
sourceraw docstring

on-watch-status-changecljs

(on-watch-status-change watch-compiler-host-of-files-and-compiler-options
                        diagnostic
                        new-line
                        options)
(on-watch-status-change watch-compiler-host-of-files-and-compiler-options
                        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

optionscljs

(options watch-compiler-host-of-files-and-compiler-options)

Compiler options

Returns: CompilerOptions

Compiler options

**Returns:** `CompilerOptions`
sourceraw docstring

parsed-command-linecljs

(parsed-command-line watch-compiler-host-of-files-and-compiler-options
                     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

project-referencescljs

(project-references watch-compiler-host-of-files-and-compiler-options)

Project References

Returns: readonly ProjectReference[] | undefined

Project References

**Returns:** `readonly ProjectReference[] | undefined`
sourceraw docstring

read-directorycljs

(read-directory watch-compiler-host-of-files-and-compiler-options path)
(read-directory watch-compiler-host-of-files-and-compiler-options
                path
                extensions)
(read-directory watch-compiler-host-of-files-and-compiler-options
                path
                extensions
                exclude)
(read-directory watch-compiler-host-of-files-and-compiler-options
                path
                extensions
                exclude
                include)
(read-directory watch-compiler-host-of-files-and-compiler-options
                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-of-files-and-compiler-options path)
(read-file watch-compiler-host-of-files-and-compiler-options 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-of-files-and-compiler-options 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-of-files-and-compiler-options
                              module-literals
                              containing-file)
(resolve-module-name-literals watch-compiler-host-of-files-and-compiler-options
                              module-literals
                              containing-file
                              redirected-reference)
(resolve-module-name-literals watch-compiler-host-of-files-and-compiler-options
                              module-literals
                              containing-file
                              redirected-reference
                              options)
(resolve-module-name-literals watch-compiler-host-of-files-and-compiler-options
                              module-literals
                              containing-file
                              redirected-reference
                              options
                              containing-source-file)
(resolve-module-name-literals watch-compiler-host-of-files-and-compiler-options
                              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-of-files-and-compiler-options
                      module-names
                      containing-file)
(resolve-module-names watch-compiler-host-of-files-and-compiler-options
                      module-names
                      containing-file
                      reused-names)
(resolve-module-names watch-compiler-host-of-files-and-compiler-options
                      module-names
                      containing-file
                      reused-names
                      redirected-reference)
(resolve-module-names watch-compiler-host-of-files-and-compiler-options
                      module-names
                      containing-file
                      reused-names
                      redirected-reference
                      options)
(resolve-module-names watch-compiler-host-of-files-and-compiler-options
                      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-of-files-and-compiler-options
  type-directive-references
  containing-file)
(resolve-type-reference-directive-references
  watch-compiler-host-of-files-and-compiler-options
  type-directive-references
  containing-file
  redirected-reference)
(resolve-type-reference-directive-references
  watch-compiler-host-of-files-and-compiler-options
  type-directive-references
  containing-file
  redirected-reference
  options)
(resolve-type-reference-directive-references
  watch-compiler-host-of-files-and-compiler-options
  type-directive-references
  containing-file
  redirected-reference
  options
  containing-source-file)
(resolve-type-reference-directive-references
  watch-compiler-host-of-files-and-compiler-options
  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-of-files-and-compiler-options
  type-reference-directive-names
  containing-file)
(resolve-type-reference-directives
  watch-compiler-host-of-files-and-compiler-options
  type-reference-directive-names
  containing-file
  redirected-reference)
(resolve-type-reference-directives
  watch-compiler-host-of-files-and-compiler-options
  type-reference-directive-names
  containing-file
  redirected-reference
  options)
(resolve-type-reference-directives
  watch-compiler-host-of-files-and-compiler-options
  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

root-filescljs

(root-files watch-compiler-host-of-files-and-compiler-options)

root files to use to generate program

Returns: string[]

root files to use to generate program

**Returns:** `string[]`
sourceraw docstring

set-create-program!cljs

(set-create-program! watch-compiler-host-of-files-and-compiler-options 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-of-files-and-compiler-options
                          value)
source

set-options!cljs

(set-options! watch-compiler-host-of-files-and-compiler-options value)

Compiler options

Compiler options
sourceraw docstring

set-project-references!cljs

(set-project-references! watch-compiler-host-of-files-and-compiler-options
                         value)

Project References

Project References
sourceraw docstring

set-root-files!cljs

(set-root-files! watch-compiler-host-of-files-and-compiler-options value)

root files to use to generate program

root files to use to generate program
sourceraw docstring

set-timeoutcljs

(set-timeout watch-compiler-host-of-files-and-compiler-options
             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

set-watch-options!cljs

(set-watch-options! watch-compiler-host-of-files-and-compiler-options value)
source

tracecljs

(trace watch-compiler-host-of-files-and-compiler-options 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-of-files-and-compiler-options)

Returns: boolean

**Returns:** `boolean`
sourceraw docstring

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

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

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-of-files-and-compiler-options
                 path
                 callback)
(watch-directory watch-compiler-host-of-files-and-compiler-options
                 path
                 callback
                 recursive?)
(watch-directory watch-compiler-host-of-files-and-compiler-options
                 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-of-files-and-compiler-options path callback)
(watch-file watch-compiler-host-of-files-and-compiler-options
            path
            callback
            polling-interval)
(watch-file watch-compiler-host-of-files-and-compiler-options
            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

watch-optionscljs

(watch-options watch-compiler-host-of-files-and-compiler-options)

Returns: WatchOptions | undefined

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

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

× close