Liking cljdoc? Tell your friends :D
ClojureScript only.

dots.typescript.compiler-host

cancellation-tokencljs

(cancellation-token compiler-host)

Returns: CancellationToken

**Returns:** `CancellationToken`
sourceraw docstring

canonical-file-namecljs

(canonical-file-name compiler-host file-name)

Parameters:

  • file-name: string

Returns: string

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

**Returns:** `string`
sourceraw docstring

create-hashcljs

(create-hash compiler-host data)

Parameters:

  • data: string

Returns: string

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

**Returns:** `string`
sourceraw docstring

current-directorycljs

(current-directory compiler-host)

Returns: string

**Returns:** `string`
sourceraw docstring

default-lib-file-namecljs

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

Parameters:

  • options: CompilerOptions

Returns: string

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

**Returns:** `string`
sourceraw docstring

default-lib-locationcljs

(default-lib-location compiler-host)

Returns: string

**Returns:** `string`
sourceraw docstring

directoriescljs

(directories compiler-host path)

Parameters:

  • path: string

Returns: string[]

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

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

directory-exists?cljs

(directory-exists? compiler-host directory-name)

Parameters:

  • directory-name: string

Returns: boolean

**Parameters:**
- `directory-name`: `string`

**Returns:** `boolean`
sourceraw docstring

environment-variablecljs

(environment-variable compiler-host name)

Parameters:

  • name: string

Returns: string | undefined

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

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

file-exists?cljs

(file-exists? compiler-host file-name)

Parameters:

  • file-name: string

Returns: boolean

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

**Returns:** `boolean`
sourceraw docstring

has-invalidated-resolutions?cljs

(has-invalidated-resolutions? 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 compiler-host)

Returns: JSDocParsingMode | undefined

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

module-resolution-cachecljs

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

Returns: string

**Returns:** `string`
sourceraw docstring

parsed-command-linecljs

(parsed-command-line compiler-host file-name)

Parameters:

  • file-name: string

Returns: ParsedCommandLine | undefined

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

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

read-directorycljs

(read-directory compiler-host root-dir extensions)
(read-directory compiler-host root-dir extensions excludes)
(read-directory compiler-host root-dir extensions excludes includes)
(read-directory compiler-host root-dir extensions excludes includes depth)

Parameters:

  • root-dir: string
  • extensions: readonly string[]
  • excludes: readonly string[] | undefined
  • includes: readonly string[]
  • depth: number | undefined

Returns: string[]

**Parameters:**
- `root-dir`: `string`
- `extensions`: `readonly string[]`
- `excludes`: `readonly string[] | undefined`
- `includes`: `readonly string[]`
- `depth`: `number | undefined`

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

read-filecljs

(read-file compiler-host file-name)

Parameters:

  • file-name: string

Returns: string | undefined

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

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

realpathcljs

(realpath compiler-host path)

Resolve a symbolic link.

Parameters:

  • path: string

Returns: string

Resolve a symbolic link.

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

**Returns:** `string`
sourceraw docstring

resolve-module-name-literalscljs

(resolve-module-name-literals compiler-host module-literals containing-file)
(resolve-module-name-literals compiler-host
                              module-literals
                              containing-file
                              redirected-reference)
(resolve-module-name-literals compiler-host
                              module-literals
                              containing-file
                              redirected-reference
                              options)
(resolve-module-name-literals compiler-host
                              module-literals
                              containing-file
                              redirected-reference
                              options
                              containing-source-file)
(resolve-module-name-literals 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 compiler-host module-names containing-file)
(resolve-module-names compiler-host module-names containing-file reused-names)
(resolve-module-names compiler-host
                      module-names
                      containing-file
                      reused-names
                      redirected-reference)
(resolve-module-names compiler-host
                      module-names
                      containing-file
                      reused-names
                      redirected-reference
                      options)
(resolve-module-names 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 compiler-host
                                             type-directive-references
                                             containing-file)
(resolve-type-reference-directive-references compiler-host
                                             type-directive-references
                                             containing-file
                                             redirected-reference)
(resolve-type-reference-directive-references compiler-host
                                             type-directive-references
                                             containing-file
                                             redirected-reference
                                             options)
(resolve-type-reference-directive-references compiler-host
                                             type-directive-references
                                             containing-file
                                             redirected-reference
                                             options
                                             containing-source-file)
(resolve-type-reference-directive-references 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 compiler-host
                                   type-reference-directive-names
                                   containing-file)
(resolve-type-reference-directives compiler-host
                                   type-reference-directive-names
                                   containing-file
                                   redirected-reference)
(resolve-type-reference-directives compiler-host
                                   type-reference-directive-names
                                   containing-file
                                   redirected-reference
                                   options)
(resolve-type-reference-directives 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-js-doc-parsing-mode!cljs

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

set-write-file!cljs

(set-write-file! compiler-host value)
source

source-filecljs

(source-file compiler-host file-name language-version-or-options)
(source-file compiler-host file-name language-version-or-options on-error)
(source-file compiler-host
             file-name
             language-version-or-options
             on-error
             should-create-new-source-file?)

Parameters:

  • file-name: string
  • language-version-or-options: ScriptTarget | CreateSourceFileOptions
  • on-error: ((message: string) => void) | undefined
  • should-create-new-source-file?: boolean | undefined

Returns: SourceFile | undefined

**Parameters:**
- `file-name`: `string`
- `language-version-or-options`: `ScriptTarget | CreateSourceFileOptions`
- `on-error`: `((message: string) => void) | undefined`
- `should-create-new-source-file?`: `boolean | undefined`

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

source-file-by-pathcljs

(source-file-by-path compiler-host file-name path language-version-or-options)
(source-file-by-path compiler-host
                     file-name
                     path
                     language-version-or-options
                     on-error)
(source-file-by-path compiler-host
                     file-name
                     path
                     language-version-or-options
                     on-error
                     should-create-new-source-file?)

Parameters:

  • file-name: string
  • path: Path
  • language-version-or-options: ScriptTarget | CreateSourceFileOptions
  • on-error: ((message: string) => void) | undefined
  • should-create-new-source-file?: boolean | undefined

Returns: SourceFile | undefined

**Parameters:**
- `file-name`: `string`
- `path`: `Path`
- `language-version-or-options`: `ScriptTarget | CreateSourceFileOptions`
- `on-error`: `((message: string) => void) | undefined`
- `should-create-new-source-file?`: `boolean | undefined`

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

tracecljs

(trace compiler-host s)

Parameters:

  • s: string

Returns: void

**Parameters:**
- `s`: `string`

**Returns:** `void`
sourceraw docstring

use-case-sensitive-file-names?cljs

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

Returns: boolean

**Returns:** `boolean`
sourceraw docstring

write-filecljs

(write-file compiler-host)

Returns: WriteFileCallback

**Returns:** `WriteFileCallback`
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
←Move to previous article
→Move to next article
Ctrl+/Jump to the search field
Raise an issueBrowse cljdoc sourceChat on Slack
× close