Liking cljdoc? Tell your friends :D

dots.typescript.program-host


create-hashcljs

(create-hash program-host data)

Parameters:

  • data: string

Returns: string

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

**Returns:** `string`
sourceraw docstring

create-programcljs

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

Returns: string

**Returns:** `string`
sourceraw docstring

default-lib-file-namecljs

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

Parameters:

  • options: CompilerOptions

Returns: string

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

**Returns:** `string`
sourceraw docstring

default-lib-locationcljs

(default-lib-location program-host)

Returns: string

**Returns:** `string`
sourceraw docstring

directoriescljs

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

Returns: JSDocParsingMode | undefined

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

module-resolution-cachecljs

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

Returns: string

**Returns:** `string`
sourceraw docstring

read-directorycljs

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

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

tracecljs

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

Returns: boolean

**Returns:** `boolean`
sourceraw docstring

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

× close