Liking cljdoc? Tell your friends :D

dots.typescript.solution-builder-host


after-program-emit-and-diagnosticscljs

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

Parameters:

  • program: T

Returns: void

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

**Returns:** `void`
sourceraw docstring

create-directorycljs

(create-directory solution-builder-host path)

Parameters:

  • path: string

Returns: void

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

**Returns:** `void`
sourceraw docstring

create-hashcljs

(create-hash solution-builder-host data)

Parameters:

  • data: string

Returns: string

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

**Returns:** `string`
sourceraw docstring

create-programcljs

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

current-directorycljs

(current-directory solution-builder-host)

Returns: string

**Returns:** `string`
sourceraw docstring

custom-transformerscljs

(custom-transformers solution-builder-host)

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

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

default-lib-file-namecljs

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

Parameters:

  • options: CompilerOptions

Returns: string

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

**Returns:** `string`
sourceraw docstring

default-lib-locationcljs

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

Returns: string

**Returns:** `string`
sourceraw docstring

delete-filecljs

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

Parameters:

  • file-name: string

Returns: void

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

**Returns:** `void`
sourceraw docstring

directoriescljs

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

environment-variablecljs

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

js-doc-parsing-modecljs

(js-doc-parsing-mode solution-builder-host)

Returns: JSDocParsingMode | undefined

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

modified-timecljs

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

Parameters:

  • file-name: string

Returns: Date | undefined

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

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

module-resolution-cachecljs

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

new-linecljs

(new-line solution-builder-host)

Returns: string

**Returns:** `string`
sourceraw docstring

parsed-command-linecljs

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

Parameters:

  • file-name: string

Returns: ParsedCommandLine | undefined

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

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

read-directorycljs

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

read-filecljs

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

realpathcljs

(realpath solution-builder-host path)

Symbol links resolution

Parameters:

  • path: string

Returns: string

Symbol links resolution

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

**Returns:** `string`
sourceraw docstring

report-diagnosticcljs

(report-diagnostic solution-builder-host)

Returns: DiagnosticReporter

**Returns:** `DiagnosticReporter`
sourceraw docstring

report-error-summarycljs

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

Returns: ReportEmitErrorSummary | undefined

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

report-solution-builder-statuscljs

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

Returns: DiagnosticReporter

**Returns:** `DiagnosticReporter`
sourceraw docstring

resolve-module-name-literalscljs

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

resolve-module-namescljs

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

resolve-type-reference-directive-referencescljs

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

resolve-type-reference-directivescljs

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

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

tracecljs

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

use-case-sensitive-file-names?cljs

(use-case-sensitive-file-names? solution-builder-host)

Returns: boolean

**Returns:** `boolean`
sourceraw docstring

write-filecljs

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

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

× close