Liking cljdoc? Tell your friends :D
ClojureScript only.

dots.typescript.server.external-project

Project whose configuration is handled externally, such as in a '.csproj'. These are created only if a host explicitly calls openExternalProject.

Project whose configuration is handled externally, such as in a '.csproj'.
These are created only if a host explicitly calls `openExternalProject`.
raw docstring

add-missing-file-rootcljs

(add-missing-file-root external-project file-name)

Parameters:

  • file-name: NormalizedPath

Returns: void

**Parameters:**
- `file-name`: `NormalizedPath`

**Returns:** `void`
sourceraw docstring

add-missing-file-watchercljs

(add-missing-file-watcher external-project)

Returns: any

**Returns:** `any`
sourceraw docstring

add-rootcljs

(add-root external-project info)
(add-root external-project info file-name)

Parameters:

  • info: ScriptInfo
  • file-name: NormalizedPath | undefined

Returns: void

**Parameters:**
- `info`: `ScriptInfo`
- `file-name`: `NormalizedPath | undefined`

**Returns:** `void`
sourceraw docstring

all-project-errorscljs

(all-project-errors external-project)

Get all the project errors

Returns: readonly Diagnostic[]

Get all the project errors

**Returns:** `readonly Diagnostic[]`
sourceraw docstring

builder-statecljs

(builder-state external-project)

Returns: any

**Returns:** `any`
sourceraw docstring

cancellation-tokencljs

(cancellation-token external-project)

Returns: any

**Returns:** `any`
sourceraw docstring

clear-generated-file-watchcljs

(clear-generated-file-watch external-project)

Returns: any

**Returns:** `any`
sourceraw docstring

closecljs

(close external-project)

Returns: void

**Returns:** `void`
sourceraw docstring

closed?cljs

(closed? external-project)

Returns: boolean

**Returns:** `boolean`
sourceraw docstring

compilation-settingscljs

(compilation-settings external-project)

Returns: CompilerOptions

**Returns:** `CompilerOptions`
sourceraw docstring

compile-on-save-affected-file-listcljs

(compile-on-save-affected-file-list external-project script-info)

Parameters:

  • script-info: ScriptInfo

Returns: string[]

**Parameters:**
- `script-info`: `ScriptInfo`

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

compile-on-save-enabled?cljs

(compile-on-save-enabled? external-project)

Returns: boolean

**Returns:** `boolean`
sourceraw docstring

compiler-optionscljs

(compiler-options external-project)

Returns: any

**Returns:** `any`
sourceraw docstring

contains-file?cljs

(contains-file? external-project filename)
(contains-file? external-project filename require-open?)

Parameters:

  • filename: NormalizedPath
  • require-open?: boolean | undefined

Returns: boolean

**Parameters:**
- `filename`: `NormalizedPath`
- `require-open?`: `boolean | undefined`

**Returns:** `boolean`
sourceraw docstring

contains-script-info?cljs

(contains-script-info? external-project info)

Parameters:

  • info: ScriptInfo

Returns: boolean

**Parameters:**
- `info`: `ScriptInfo`

**Returns:** `boolean`
sourceraw docstring

create-generated-file-watchercljs

(create-generated-file-watcher external-project)

Returns: any

**Returns:** `any`
sourceraw docstring

current-directorycljs

(current-directory external-project)

Returns: string

**Returns:** `string`
sourceraw docstring

default-lib-file-namecljs

(default-lib-file-name external-project)

Returns: string

**Returns:** `string`
sourceraw docstring

detach-script-info-from-projectcljs

(detach-script-info-from-project external-project)

Returns: any

**Returns:** `any`
sourceraw docstring

detach-script-info-if-not-rootcljs

(detach-script-info-if-not-root external-project)

Returns: any

**Returns:** `any`
sourceraw docstring

directoriescljs

(directories external-project path)

Parameters:

  • path: string

Returns: string[]

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

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

directory-exists?cljs

(directory-exists? external-project path)

Parameters:

  • path: string

Returns: boolean

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

**Returns:** `boolean`
sourceraw docstring

disable-language-servicecljs

(disable-language-service external-project)
(disable-language-service external-project last-file-exceeded-program-size)

Parameters:

  • last-file-exceeded-program-size: string | undefined

Returns: void

**Parameters:**
- `last-file-exceeded-program-size`: `string | undefined`

**Returns:** `void`
sourceraw docstring

document-registrycljs

(document-registry external-project)

Returns: any

**Returns:** `any`
sourceraw docstring

emit-filecljs

(emit-file external-project script-info write-file)

Returns true if emit was conducted

Parameters:

  • script-info: ScriptInfo
  • write-file: (path: string, data: string, writeByteOrderMark?: boolean | undefined) => void

Returns: EmitResult

Returns true if emit was conducted

**Parameters:**
- `script-info`: `ScriptInfo`
- `write-file`: `(path: string, data: string, writeByteOrderMark?: boolean | undefined) => void`

**Returns:** `EmitResult`
sourceraw docstring

enable-global-pluginscljs

(enable-global-plugins external-project options)

Parameters:

  • options: CompilerOptions

Returns: void

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

**Returns:** `void`
sourceraw docstring

enable-language-servicecljs

(enable-language-service external-project)

Returns: void

**Returns:** `void`
sourceraw docstring

enable-plugincljs

(enable-plugin external-project plugin-config-entry search-paths)

Parameters:

  • plugin-config-entry: PluginImport
  • search-paths: string[]

Returns: void

**Parameters:**
- `plugin-config-entry`: `PluginImport`
- `search-paths`: `string[]`

**Returns:** `void`
sourceraw docstring

errorcljs

(error external-project s)

Parameters:

  • s: string

Returns: void

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

**Returns:** `void`
sourceraw docstring

excluded-filescljs

(excluded-files external-project)

Returns: readonly NormalizedPath[]

**Returns:** `readonly NormalizedPath[]`
sourceraw docstring

external-filescljs

(external-files external-project)

Returns: any

**Returns:** `any`
sourceraw docstring

external-project-namecljs

(external-project-name external-project)

Returns: string

**Returns:** `string`
sourceraw docstring

file-exists?cljs

(file-exists? external-project file)

Parameters:

  • file: string

Returns: boolean

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

**Returns:** `boolean`
sourceraw docstring

file-namescljs

(file-names external-project)
(file-names external-project exclude-files-from-external-libraries?)
(file-names external-project
            exclude-files-from-external-libraries?
            exclude-config-files?)

Parameters:

  • exclude-files-from-external-libraries?: boolean | undefined
  • exclude-config-files?: boolean | undefined

Returns: NormalizedPath[]

**Parameters:**
- `exclude-files-from-external-libraries?`: `boolean | undefined`
- `exclude-config-files?`: `boolean | undefined`

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

files-to-stringcljs

(files-to-string external-project write-project-file-names?)

Parameters:

  • write-project-file-names?: boolean

Returns: string

**Parameters:**
- `write-project-file-names?`: `boolean`

**Returns:** `string`
sourceraw docstring

generated-files-mapcljs

(generated-files-map external-project)

Returns: any

**Returns:** `any`
sourceraw docstring

get-cancellation-tokencljs

(get-cancellation-token external-project)

Returns: HostCancellationToken

**Returns:** `HostCancellationToken`
sourceraw docstring

get-compiler-optionscljs

(get-compiler-options external-project)

Returns: CompilerOptions

**Returns:** `CompilerOptions`
sourceraw docstring

get-excluded-filescljs

(get-excluded-files external-project)

Returns: readonly NormalizedPath[]

**Returns:** `readonly NormalizedPath[]`
sourceraw docstring

get-external-filescljs

(get-external-files external-project)
(get-external-files external-project update-level)

Parameters:

  • update-level: ProgramUpdateLevel | undefined

Returns: SortedReadonlyArray<string>

**Parameters:**
- `update-level`: `ProgramUpdateLevel | undefined`

**Returns:** `SortedReadonlyArray<string>`
sourceraw docstring

get-language-servicecljs

(get-language-service external-project)
(get-language-service external-project ensure-synchronized?)

Parameters:

  • ensure-synchronized?: boolean | undefined

Returns: LanguageService

**Parameters:**
- `ensure-synchronized?`: `boolean | undefined`

**Returns:** `LanguageService`
sourceraw docstring

get-root-filescljs

(get-root-files external-project)

Returns: NormalizedPath[]

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

global-project-errorscljs

(global-project-errors external-project)

Get the errors that dont have any file name associated

Returns: readonly Diagnostic[]

Get the errors that dont have any file name associated

**Returns:** `readonly Diagnostic[]`
sourceraw docstring

has-config-file?cljs

(has-config-file? external-project config-file-path)

Parameters:

  • config-file-path: NormalizedPath

Returns: boolean

**Parameters:**
- `config-file-path`: `NormalizedPath`

**Returns:** `boolean`
sourceraw docstring

has-roots?cljs

(has-roots? external-project)

Returns: boolean

**Returns:** `boolean`
sourceraw docstring

initial-load-pendingcljs

(initial-load-pending external-project)

Returns: () => boolean

**Returns:** `() => boolean`
sourceraw docstring

install-packagecljs

(install-package external-project options)

Parameters:

  • options: InstallPackageOptions

Returns: Promise<ApplyCodeActionCommandResult>

**Parameters:**
- `options`: `InstallPackageOptions`

**Returns:** `Promise<ApplyCodeActionCommandResult>`
sourceraw docstring

js-doc-parsing-modecljs

(js-doc-parsing-mode external-project)

Returns: JSDocParsingMode | undefined

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

js-only-project?cljs

(js-only-project? external-project)

Returns: boolean

**Returns:** `boolean`
sourceraw docstring

known-types-package-name?cljs

(known-types-package-name? external-project name)

Parameters:

  • name: string

Returns: boolean

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

**Returns:** `boolean`
sourceraw docstring

language-servicecljs

(language-service external-project)

Returns: LanguageService

**Returns:** `LanguageService`
sourceraw docstring

language-service-enabled?cljs

(language-service-enabled? external-project)

Returns: boolean

**Returns:** `boolean`
sourceraw docstring

last-reported-file-namescljs

(last-reported-file-names external-project)

Set of files that was returned from the last call to getChangesSinceVersion.

Returns: any

Set of files that was returned from the last call to getChangesSinceVersion.

**Returns:** `any`
sourceraw docstring

last-reported-versioncljs

(last-reported-version external-project)

Last version that was reported.

Returns: any

Last version that was reported.

**Returns:** `any`
sourceraw docstring

logcljs

(log external-project s)

Parameters:

  • s: string

Returns: void

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

**Returns:** `void`
sourceraw docstring

mark-as-dirtycljs

(mark-as-dirty external-project)

Returns: void

**Returns:** `void`
sourceraw docstring

missing-files-mapcljs

(missing-files-map external-project)

Returns: any

**Returns:** `any`
sourceraw docstring

new-linecljs

(new-line external-project)

Returns: string

**Returns:** `string`
sourceraw docstring

non-ts-project?cljs

(non-ts-project? external-project)

Returns: boolean

**Returns:** `boolean`
sourceraw docstring

or-create-script-info-and-attach-to-projectcljs

(or-create-script-info-and-attach-to-project external-project)

Returns: any

**Returns:** `any`
sourceraw docstring

programcljs

(program external-project)

Returns: any

**Returns:** `any`
sourceraw docstring

project-errorscljs

(project-errors external-project)

Returns: Diagnostic[] | undefined

**Returns:** `Diagnostic[] | undefined`
sourceraw docstring

project-kindcljs

(project-kind external-project)

Returns: ProjectKind

**Returns:** `ProjectKind`
sourceraw docstring

project-namecljs

(project-name external-project)

Returns: string

**Returns:** `string`
sourceraw docstring

project-referencescljs

(project-references external-project)

Returns: readonly ProjectReference[] | undefined

**Returns:** `readonly ProjectReference[] | undefined`
sourceraw docstring

project-servicecljs

(project-service external-project)

Returns: ProjectService

**Returns:** `ProjectService`
sourceraw docstring

project-versioncljs

(project-version external-project)

Returns: string

**Returns:** `string`
sourceraw docstring

read-directorycljs

(read-directory external-project path)
(read-directory external-project path extensions)
(read-directory external-project path extensions exclude)
(read-directory external-project path extensions exclude include)
(read-directory external-project path extensions exclude include depth)

Parameters:

  • path: string
  • extensions: readonly string[] | undefined
  • exclude: readonly string[] | undefined
  • include: readonly string[] | undefined
  • depth: number | undefined

Returns: string[]

**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 external-project file-name)

Parameters:

  • file-name: string

Returns: string | undefined

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

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

realpathcljs

(realpath external-project)

Returns: ((path: string) => string) | undefined

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

refresh-diagnosticscljs

(refresh-diagnostics external-project)

Starts a new check for diagnostics. Call this if some file has updated that would cause diagnostics to be changed.

Returns: void

Starts a new check for diagnostics. Call this if some file has updated that would cause diagnostics to be changed.

**Returns:** `void`
sourceraw docstring

register-file-updatecljs

(register-file-update external-project file-name)

Parameters:

  • file-name: string

Returns: void

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

**Returns:** `void`
sourceraw docstring

remove-existing-typingscljs

(remove-existing-typings external-project include)

Parameters:

  • include: string[]

Returns: string[]

**Parameters:**
- `include`: `string[]`

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

remove-filecljs

(remove-file external-project info file-exists? detach-from-project?)

Parameters:

  • info: ScriptInfo
  • file-exists?: boolean
  • detach-from-project?: boolean

Returns: void

**Parameters:**
- `info`: `ScriptInfo`
- `file-exists?`: `boolean`
- `detach-from-project?`: `boolean`

**Returns:** `void`
sourceraw docstring

remove-local-typings-from-type-acquisitioncljs

(remove-local-typings-from-type-acquisition external-project
                                            new-type-acquisition)

Parameters:

  • new-type-acquisition: TypeAcquisition

Returns: TypeAcquisition

**Parameters:**
- `new-type-acquisition`: `TypeAcquisition`

**Returns:** `TypeAcquisition`
sourceraw docstring

remove-rootcljs

(remove-root external-project info)

Parameters:

  • info: ScriptInfo

Returns: void

**Parameters:**
- `info`: `ScriptInfo`

**Returns:** `void`
sourceraw docstring

root-filescljs

(root-files external-project)

Returns: any

**Returns:** `any`
sourceraw docstring

root-files-mapcljs

(root-files-map external-project)

Returns: any

**Returns:** `any`
sourceraw docstring

root-script-infoscljs

(root-script-infos external-project)

Returns: ScriptInfo[]

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

root?cljs

(root? external-project info)

Parameters:

  • info: ScriptInfo

Returns: boolean

**Parameters:**
- `info`: `ScriptInfo`

**Returns:** `boolean`
sourceraw docstring

script-file-namescljs

(script-file-names external-project)

Returns: string[]

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

script-infocljs

(script-info external-project unchecked-file-name)

Parameters:

  • unchecked-file-name: string

Returns: ScriptInfo | undefined

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

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

script-info-for-normalized-pathcljs

(script-info-for-normalized-path external-project file-name)

Parameters:

  • file-name: NormalizedPath

Returns: ScriptInfo | undefined

**Parameters:**
- `file-name`: `NormalizedPath`

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

script-infoscljs

(script-infos external-project)

Returns: ScriptInfo[]

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

script-kindcljs

(script-kind external-project file-name)

Parameters:

  • file-name: string

Returns: ScriptKind

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

**Returns:** `ScriptKind`
sourceraw docstring

script-snapshotcljs

(script-snapshot external-project filename)

Parameters:

  • filename: string

Returns: IScriptSnapshot | undefined

**Parameters:**
- `filename`: `string`

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

script-versioncljs

(script-version external-project filename)

Parameters:

  • filename: string

Returns: string

**Parameters:**
- `filename`: `string`

**Returns:** `string`
sourceraw docstring

set-add-missing-file-watcher!cljs

(set-add-missing-file-watcher! external-project value)
source

set-builder-state!cljs

(set-builder-state! external-project value)
source

set-clear-generated-file-watch!cljs

(set-clear-generated-file-watch! external-project value)
source

set-compile-on-save-enabled!cljs

(set-compile-on-save-enabled! external-project value)
source

set-compiler-optionscljs

(set-compiler-options external-project compiler-options)

Parameters:

  • compiler-options: CompilerOptions

Returns: void

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

**Returns:** `void`
sourceraw docstring

set-compiler-options!cljs

(set-compiler-options! external-project value)
source

set-create-generated-file-watcher!cljs

(set-create-generated-file-watcher! external-project value)
source

set-detach-script-info-from-project!cljs

(set-detach-script-info-from-project! external-project value)
source

set-detach-script-info-if-not-root!cljs

(set-detach-script-info-if-not-root! external-project value)
source

set-document-registry!cljs

(set-document-registry! external-project value)
source

set-excluded-files!cljs

(set-excluded-files! external-project value)
source

set-external-files!cljs

(set-external-files! external-project value)
source

set-external-project-name!cljs

(set-external-project-name! external-project value)
source

set-generated-files-map!cljs

(set-generated-files-map! external-project value)
source

set-get-or-create-script-info-and-attach-to-project!cljs

(set-get-or-create-script-info-and-attach-to-project! external-project value)
source

set-internal-compiler-options-for-emitting-js-filescljs

(set-internal-compiler-options-for-emitting-js-files external-project)

Returns: any

**Returns:** `any`
sourceraw docstring

set-is-initial-load-pending!cljs

(set-is-initial-load-pending! external-project value)
source

set-is-valid-generated-file-watcher!cljs

(set-is-valid-generated-file-watcher! external-project value)
source

set-is-watched-missing-file!cljs

(set-is-watched-missing-file! external-project value)
source

set-language-service!cljs

(set-language-service! external-project value)
source

set-language-service-enabled!cljs

(set-language-service-enabled! external-project value)
source

set-last-reported-file-names!cljs

(set-last-reported-file-names! external-project value)

Set of files that was returned from the last call to getChangesSinceVersion.

Set of files that was returned from the last call to getChangesSinceVersion.
sourceraw docstring

set-last-reported-version!cljs

(set-last-reported-version! external-project value)

Last version that was reported.

Last version that was reported.
sourceraw docstring

set-missing-files-map!cljs

(set-missing-files-map! external-project value)
source

set-program!cljs

(set-program! external-project value)
source

set-project-errorscljs

(set-project-errors external-project)
(set-project-errors external-project project-errors)

Parameters:

  • project-errors: Diagnostic[] | undefined

Returns: void

**Parameters:**
- `project-errors`: `Diagnostic[] | undefined`

**Returns:** `void`
sourceraw docstring

set-project-errors!cljs

(set-project-errors! external-project value)
source

set-root-files!cljs

(set-root-files! external-project value)
source

set-root-files-map!cljs

(set-root-files-map! external-project value)
source

set-set-internal-compiler-options-for-emitting-js-files!cljs

(set-set-internal-compiler-options-for-emitting-js-files! external-project
                                                          value)
source

set-type-acquisitioncljs

(set-type-acquisition external-project)
(set-type-acquisition external-project new-type-acquisition)

Parameters:

  • new-type-acquisition: TypeAcquisition | undefined

Returns: void

**Parameters:**
- `new-type-acquisition`: `TypeAcquisition | undefined`

**Returns:** `void`
sourceraw docstring

set-update-graph-worker!cljs

(set-update-graph-worker! external-project value)
source

set-updated-file-names!cljs

(set-updated-file-names! external-project value)

Set of files names that were updated since the last call to getChangesSinceVersion.

Set of files names that were updated since the last call to getChangesSinceVersion.
sourceraw docstring

set-watch-options!cljs

(set-watch-options! external-project value)
source

source-filecljs

(source-file external-project path)

Parameters:

  • path: Path

Returns: SourceFile | undefined

**Parameters:**
- `path`: `Path`

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

tracecljs

(trace external-project)

Returns: ((s: string) => void) | undefined

**Returns:** `((s: string) => void) | undefined`
sourceraw docstring

type-acquisitioncljs

(type-acquisition external-project)

Returns: TypeAcquisition

**Returns:** `TypeAcquisition`
sourceraw docstring

update-graph-workercljs

(update-graph-worker external-project)

Returns: any

**Returns:** `any`
sourceraw docstring

update-graph?cljs

(update-graph? external-project)

Returns: boolean - : true if set of files in the project stays the same and false - otherwise.

**Returns:** `boolean` - : true if set of files in the project stays the same and false - otherwise.
sourceraw docstring

updated-file-namescljs

(updated-file-names external-project)

Set of files names that were updated since the last call to getChangesSinceVersion.

Returns: any

Set of files names that were updated since the last call to getChangesSinceVersion.

**Returns:** `any`
sourceraw docstring

use-case-sensitive-file-names?cljs

(use-case-sensitive-file-names? external-project)

Returns: boolean

**Returns:** `boolean`
sourceraw docstring

valid-generated-file-watchercljs

(valid-generated-file-watcher external-project)

Returns: any

**Returns:** `any`
sourceraw docstring

watch-optionscljs

(watch-options external-project)

Returns: WatchOptions | undefined

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

watched-missing-filecljs

(watched-missing-file external-project)

Returns: any

**Returns:** `any`
sourceraw docstring

write-filecljs

(write-file external-project file-name content)

Parameters:

  • file-name: string
  • content: string

Returns: void

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

**Returns:** `void`
sourceraw docstring

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

× close