(after-program-emit-and-diagnostics solution-builder-with-watch-host program)Parameters:
program: TReturns: void
**Parameters:** - `program`: `T` **Returns:** `void`
(clear-timeout solution-builder-with-watch-host timeout-id)If provided, will be used to reset existing delayed compilation
Parameters:
timeout-id: anyReturns: void
If provided, will be used to reset existing delayed compilation **Parameters:** - `timeout-id`: `any` **Returns:** `void`
(create-directory solution-builder-with-watch-host path)Parameters:
path: stringReturns: void
**Parameters:** - `path`: `string` **Returns:** `void`
(create-hash solution-builder-with-watch-host data)Parameters:
data: stringReturns: string
**Parameters:** - `data`: `string` **Returns:** `string`
(create-program solution-builder-with-watch-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>`
(current-directory solution-builder-with-watch-host)Returns: string
**Returns:** `string`
(custom-transformers solution-builder-with-watch-host)Returns: ((project: string) => CustomTransformers | undefined) | undefined
**Returns:** `((project: string) => CustomTransformers | undefined) | undefined`
(default-lib-file-name solution-builder-with-watch-host options)Parameters:
options: CompilerOptionsReturns: string
**Parameters:** - `options`: `CompilerOptions` **Returns:** `string`
(default-lib-location solution-builder-with-watch-host)Returns: string
**Returns:** `string`
(delete-file solution-builder-with-watch-host file-name)Parameters:
file-name: stringReturns: void
**Parameters:** - `file-name`: `string` **Returns:** `void`
(directories solution-builder-with-watch-host path)If provided, used in resolutions as well as handling directory structure
Parameters:
path: stringReturns: string[]
If provided, used in resolutions as well as handling directory structure **Parameters:** - `path`: `string` **Returns:** `string[]`
(directory-exists? solution-builder-with-watch-host path)If provided, used for module resolution as well as to handle directory structure
Parameters:
path: stringReturns: boolean
If provided, used for module resolution as well as to handle directory structure **Parameters:** - `path`: `string` **Returns:** `boolean`
(environment-variable solution-builder-with-watch-host name)If provided is used to get the environment variable
Parameters:
name: stringReturns: string | undefined
If provided is used to get the environment variable **Parameters:** - `name`: `string` **Returns:** `string | undefined`
(file-exists? solution-builder-with-watch-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: stringReturns: 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`
(has-invalidated-resolutions? solution-builder-with-watch-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: PathReturns: 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`
(js-doc-parsing-mode solution-builder-with-watch-host)Returns: JSDocParsingMode | undefined
**Returns:** `JSDocParsingMode | undefined`
(modified-time solution-builder-with-watch-host file-name)Parameters:
file-name: stringReturns: Date | undefined
**Parameters:** - `file-name`: `string` **Returns:** `Date | undefined`
(module-resolution-cache solution-builder-with-watch-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`
(new-line solution-builder-with-watch-host)Returns: string
**Returns:** `string`
(on-watch-status-change solution-builder-with-watch-host
diagnostic
new-line
options)(on-watch-status-change solution-builder-with-watch-host
diagnostic
new-line
options
error-count)If provided, called with Diagnostic message that informs about change in watch status
Parameters:
diagnostic: Diagnosticnew-line: stringoptions: CompilerOptionserror-count: number | undefinedReturns: 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`
(parsed-command-line solution-builder-with-watch-host file-name)Parameters:
file-name: stringReturns: ParsedCommandLine | undefined
**Parameters:** - `file-name`: `string` **Returns:** `ParsedCommandLine | undefined`
(read-directory solution-builder-with-watch-host path)(read-directory solution-builder-with-watch-host path extensions)(read-directory solution-builder-with-watch-host path extensions exclude)(read-directory solution-builder-with-watch-host
path
extensions
exclude
include)(read-directory solution-builder-with-watch-host
path
extensions
exclude
include
depth)If provided, used to cache and handle directory structure modifications
Parameters:
path: stringextensions: readonly string[] | undefinedexclude: readonly string[] | undefinedinclude: readonly string[] | undefineddepth: number | undefinedReturns: 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[]`
(read-file solution-builder-with-watch-host path)(read-file solution-builder-with-watch-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: stringencoding: string | undefinedReturns: 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`
(realpath solution-builder-with-watch-host path)Symbol links resolution
Parameters:
path: stringReturns: string
Symbol links resolution **Parameters:** - `path`: `string` **Returns:** `string`
(report-diagnostic solution-builder-with-watch-host)Returns: DiagnosticReporter
**Returns:** `DiagnosticReporter`
(report-solution-builder-status solution-builder-with-watch-host)Returns: DiagnosticReporter
**Returns:** `DiagnosticReporter`
(resolve-module-name-literals solution-builder-with-watch-host
module-literals
containing-file)(resolve-module-name-literals solution-builder-with-watch-host
module-literals
containing-file
redirected-reference)(resolve-module-name-literals solution-builder-with-watch-host
module-literals
containing-file
redirected-reference
options)(resolve-module-name-literals solution-builder-with-watch-host
module-literals
containing-file
redirected-reference
options
containing-source-file)(resolve-module-name-literals solution-builder-with-watch-host
module-literals
containing-file
redirected-reference
options
containing-source-file
reused-names)Parameters:
module-literals: readonly StringLiteralLike[]containing-file: stringredirected-reference: ResolvedProjectReference | undefinedoptions: CompilerOptionscontaining-source-file: SourceFilereused-names: readonly StringLiteralLike[] | undefinedReturns: 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[]`
(resolve-module-names solution-builder-with-watch-host
module-names
containing-file)(resolve-module-names solution-builder-with-watch-host
module-names
containing-file
reused-names)(resolve-module-names solution-builder-with-watch-host
module-names
containing-file
reused-names
redirected-reference)(resolve-module-names solution-builder-with-watch-host
module-names
containing-file
reused-names
redirected-reference
options)(resolve-module-names solution-builder-with-watch-host
module-names
containing-file
reused-names
redirected-reference
options
containing-source-file)Parameters:
module-names: string[]containing-file: stringreused-names: string[] | undefinedredirected-reference: ResolvedProjectReference | undefinedoptions: CompilerOptionscontaining-source-file: SourceFile | undefinedReturns: (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)[]`
(resolve-type-reference-directive-references solution-builder-with-watch-host
type-directive-references
containing-file)(resolve-type-reference-directive-references solution-builder-with-watch-host
type-directive-references
containing-file
redirected-reference)(resolve-type-reference-directive-references solution-builder-with-watch-host
type-directive-references
containing-file
redirected-reference
options)(resolve-type-reference-directive-references solution-builder-with-watch-host
type-directive-references
containing-file
redirected-reference
options
containing-source-file)(resolve-type-reference-directive-references solution-builder-with-watch-host
type-directive-references
containing-file
redirected-reference
options
containing-source-file
reused-names)Parameters:
type-directive-references: readonly T[]containing-file: stringredirected-reference: ResolvedProjectReference | undefinedoptions: CompilerOptionscontaining-source-file: SourceFile | undefinedreused-names: readonly T[] | undefinedReturns: 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[]`
(resolve-type-reference-directives solution-builder-with-watch-host
type-reference-directive-names
containing-file)(resolve-type-reference-directives solution-builder-with-watch-host
type-reference-directive-names
containing-file
redirected-reference)(resolve-type-reference-directives solution-builder-with-watch-host
type-reference-directive-names
containing-file
redirected-reference
options)(resolve-type-reference-directives solution-builder-with-watch-host
type-reference-directive-names
containing-file
redirected-reference
options
containing-file-mode)Parameters:
type-reference-directive-names: string[] | readonly FileReference[]containing-file: stringredirected-reference: ResolvedProjectReference | undefinedoptions: CompilerOptionscontaining-file-mode: ResolutionModeReturns: (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)[]`
(set-create-program! solution-builder-with-watch-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
(set-get-custom-transformers! solution-builder-with-watch-host value)(set-modified-time solution-builder-with-watch-host file-name date)Parameters:
file-name: stringdate: DateReturns: void
**Parameters:** - `file-name`: `string` - `date`: `Date` **Returns:** `void`
(set-report-solution-builder-status! solution-builder-with-watch-host value)(set-timeout solution-builder-with-watch-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[]) => voidms: numberargs: 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`
(trace solution-builder-with-watch-host s)If provided would be used to write log about compilation
Parameters:
s: stringReturns: void
If provided would be used to write log about compilation **Parameters:** - `s`: `string` **Returns:** `void`
(use-case-sensitive-file-names? solution-builder-with-watch-host)Returns: boolean
**Returns:** `boolean`
(watch-directory solution-builder-with-watch-host path callback)(watch-directory solution-builder-with-watch-host path callback recursive?)(watch-directory solution-builder-with-watch-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: stringcallback: DirectoryWatcherCallbackrecursive?: boolean | undefinedoptions: WatchOptions | undefinedReturns: 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`
(watch-file solution-builder-with-watch-host path callback)(watch-file solution-builder-with-watch-host path callback polling-interval)(watch-file solution-builder-with-watch-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: stringcallback: FileWatcherCallbackpolling-interval: number | undefinedoptions: WatchOptions | undefinedReturns: 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`
(write-file solution-builder-with-watch-host path data)(write-file solution-builder-with-watch-host path data write-byte-order-mark?)Should provide create directory and writeFile if done of invalidatedProjects is not invoked with writeFileCallback
Parameters:
path: stringdata: stringwrite-byte-order-mark?: boolean | undefinedReturns: void
Should provide create directory and writeFile if done of invalidatedProjects is not invoked with writeFileCallback **Parameters:** - `path`: `string` - `data`: `string` - `write-byte-order-mark?`: `boolean | undefined` **Returns:** `void`
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |