dots.typescript.solution-builder-host

Liking cljdoc? Tell your friends :D

ClojureScript only.

after-program-emit-and-diagnostics^cljs

(after-program-emit-and-diagnostics solution-builder-host program)

Parameters:

program: T

Returns: void

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

**Returns:** `void`

source raw docstring

create-directory^cljs

(create-directory solution-builder-host path)

Parameters:

path: string

Returns: void

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

**Returns:** `void`

source raw docstring

create-hash^cljs

(create-hash solution-builder-host data)

Parameters:

data: string

Returns: string

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

**Returns:** `string`

source raw docstring

create-program^cljs

(create-program solution-builder-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 solution-builder-host)

Returns: string

**Returns:** `string`

source raw docstring

custom-transformers^cljs

(custom-transformers solution-builder-host)

Returns: ((project: string) => CustomTransformers | undefined) | undefined

**Returns:** `((project: string) => CustomTransformers | undefined) | undefined`

source raw docstring

default-lib-file-name^cljs

(default-lib-file-name solution-builder-host options)

Parameters:

options: CompilerOptions

Returns: string

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

**Returns:** `string`

source raw docstring

default-lib-location^cljs

(default-lib-location solution-builder-host)

Returns: string

**Returns:** `string`

source raw docstring

delete-file^cljs

(delete-file solution-builder-host file-name)

Parameters:

file-name: string

Returns: void

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

**Returns:** `void`

source raw docstring

directories^cljs

(directories solution-builder-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? solution-builder-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 solution-builder-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? solution-builder-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? solution-builder-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 solution-builder-host)

Returns: JSDocParsingMode | undefined

**Returns:** `JSDocParsingMode | undefined`

source raw docstring

modified-time^cljs

(modified-time solution-builder-host file-name)

Parameters:

file-name: string

Returns: Date | undefined

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

**Returns:** `Date | undefined`

source raw docstring

module-resolution-cache^cljs

(module-resolution-cache solution-builder-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 solution-builder-host)

Returns: string

**Returns:** `string`

source raw docstring

parsed-command-line^cljs

(parsed-command-line solution-builder-host file-name)

Parameters:

file-name: string

Returns: ParsedCommandLine | undefined

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

**Returns:** `ParsedCommandLine | undefined`

source raw docstring

read-directory^cljs

(read-directory solution-builder-host path)

(read-directory solution-builder-host path extensions)

(read-directory solution-builder-host path extensions exclude)

(read-directory solution-builder-host path extensions exclude include)

(read-directory solution-builder-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 solution-builder-host path)

(read-file solution-builder-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 solution-builder-host path)

Symbol links resolution

Parameters:

path: string

Returns: string

Symbol links resolution

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

**Returns:** `string`

source raw docstring

report-diagnostic^cljs

(report-diagnostic solution-builder-host)

Returns: DiagnosticReporter

**Returns:** `DiagnosticReporter`

source raw docstring

report-error-summary^cljs

(report-error-summary solution-builder-host)

Returns: ReportEmitErrorSummary | undefined

**Returns:** `ReportEmitErrorSummary | undefined`

source raw docstring

report-solution-builder-status^cljs

(report-solution-builder-status solution-builder-host)

Returns: DiagnosticReporter

**Returns:** `DiagnosticReporter`

source raw docstring

resolve-module-name-literals^cljs

(resolve-module-name-literals solution-builder-host
                              module-literals
                              containing-file)

(resolve-module-name-literals solution-builder-host
                              module-literals
                              containing-file
                              redirected-reference)

(resolve-module-name-literals solution-builder-host
                              module-literals
                              containing-file
                              redirected-reference
                              options)

(resolve-module-name-literals solution-builder-host
                              module-literals
                              containing-file
                              redirected-reference
                              options
                              containing-source-file)

(resolve-module-name-literals solution-builder-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 solution-builder-host module-names containing-file)

(resolve-module-names solution-builder-host
                      module-names
                      containing-file
                      reused-names)

(resolve-module-names solution-builder-host
                      module-names
                      containing-file
                      reused-names
                      redirected-reference)

(resolve-module-names solution-builder-host
                      module-names
                      containing-file
                      reused-names
                      redirected-reference
                      options)

(resolve-module-names solution-builder-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 solution-builder-host
                                             type-directive-references
                                             containing-file)

(resolve-type-reference-directive-references solution-builder-host
                                             type-directive-references
                                             containing-file
                                             redirected-reference)

(resolve-type-reference-directive-references solution-builder-host
                                             type-directive-references
                                             containing-file
                                             redirected-reference
                                             options)

(resolve-type-reference-directive-references solution-builder-host
                                             type-directive-references
                                             containing-file
                                             redirected-reference
                                             options
                                             containing-source-file)

(resolve-type-reference-directive-references solution-builder-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 solution-builder-host
                                   type-reference-directive-names
                                   containing-file)

(resolve-type-reference-directives solution-builder-host
                                   type-reference-directive-names
                                   containing-file
                                   redirected-reference)

(resolve-type-reference-directives solution-builder-host
                                   type-reference-directive-names
                                   containing-file
                                   redirected-reference
                                   options)

(resolve-type-reference-directives solution-builder-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! solution-builder-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-get-custom-transformers!^cljs

(set-get-custom-transformers! solution-builder-host value)

source

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

(set-js-doc-parsing-mode! solution-builder-host value)

source

set-modified-time^cljs

(set-modified-time solution-builder-host file-name date)

Parameters:

file-name: string
date: Date

Returns: void

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

**Returns:** `void`

source raw docstring

set-report-diagnostic!^cljs

(set-report-diagnostic! solution-builder-host value)

source

set-report-error-summary!^cljs

(set-report-error-summary! solution-builder-host value)

source

set-report-solution-builder-status!^cljs

(set-report-solution-builder-status! solution-builder-host value)

source

trace^cljs

(trace solution-builder-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? solution-builder-host)

Returns: boolean

**Returns:** `boolean`

source raw docstring

write-file^cljs

(write-file solution-builder-host path data)

(write-file solution-builder-host path data write-byte-order-mark?)

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

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`

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