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-root^cljs

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

Parameters:

file-name: NormalizedPath

Returns: void

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

**Returns:** `void`

source raw docstring

add-missing-file-watcher^cljs

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

Returns: any

**Returns:** `any`

source raw docstring

add-root^cljs

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

source raw docstring

all-project-errors^cljs

(all-project-errors external-project)

Get all the project errors

Returns: readonly Diagnostic[]

Get all the project errors

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

source raw docstring

builder-state^cljs

(builder-state external-project)

Returns: any

**Returns:** `any`

source raw docstring

cancellation-token^cljs

(cancellation-token external-project)

Returns: any

**Returns:** `any`

source raw docstring

clear-generated-file-watch^cljs

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

Returns: any

**Returns:** `any`

source raw docstring

close^cljs

(close external-project)

Returns: void

**Returns:** `void`

source raw docstring

closed?^cljs

(closed? external-project)

Returns: boolean

**Returns:** `boolean`

source raw docstring

compilation-settings^cljs

(compilation-settings external-project)

Returns: CompilerOptions

**Returns:** `CompilerOptions`

source raw docstring

compile-on-save-affected-file-list^cljs

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

Parameters:

script-info: ScriptInfo

Returns: string[]

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

**Returns:** `string[]`

source raw docstring

compile-on-save-enabled?^cljs

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

Returns: boolean

**Returns:** `boolean`

source raw docstring

compiler-options^cljs

(compiler-options external-project)

Returns: any

**Returns:** `any`

source raw 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`

source raw docstring

contains-script-info?^cljs

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

Parameters:

info: ScriptInfo

Returns: boolean

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

**Returns:** `boolean`

source raw docstring

create-generated-file-watcher^cljs

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

Returns: any

**Returns:** `any`

source raw docstring

current-directory^cljs

(current-directory external-project)

Returns: string

**Returns:** `string`

source raw docstring

default-lib-file-name^cljs

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

Returns: string

**Returns:** `string`

source raw docstring

detach-script-info-from-project^cljs

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

Returns: any

**Returns:** `any`

source raw docstring

detach-script-info-if-not-root^cljs

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

Returns: any

**Returns:** `any`

source raw docstring

directories^cljs

(directories external-project path)

Parameters:

path: string

Returns: string[]

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

**Returns:** `string[]`

source raw docstring

directory-exists?^cljs

(directory-exists? external-project path)

Parameters:

path: string

Returns: boolean

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

**Returns:** `boolean`

source raw docstring

disable-language-service^cljs

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

source raw docstring

document-registry^cljs

(document-registry external-project)

Returns: any

**Returns:** `any`

source raw docstring

emit-file^cljs

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

source raw docstring

enable-global-plugins^cljs

(enable-global-plugins external-project options)

Parameters:

options: CompilerOptions

Returns: void

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

**Returns:** `void`

source raw docstring

enable-language-service^cljs

(enable-language-service external-project)

Returns: void

**Returns:** `void`

source raw docstring

enable-plugin^cljs

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

source raw docstring

error^cljs

(error external-project s)

Parameters:

s: string

Returns: void

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

**Returns:** `void`

source raw docstring

excluded-files^cljs

(excluded-files external-project)

Returns: readonly NormalizedPath[]

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

source raw docstring

external-files^cljs

(external-files external-project)

Returns: any

**Returns:** `any`

source raw docstring

external-project-name^cljs

(external-project-name external-project)

Returns: string

**Returns:** `string`

source raw docstring

file-exists?^cljs

(file-exists? external-project file)

Parameters:

file: string

Returns: boolean

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

**Returns:** `boolean`

source raw docstring

file-names^cljs

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

source raw docstring

files-to-string^cljs

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

source raw docstring

generated-files-map^cljs

(generated-files-map external-project)

Returns: any

**Returns:** `any`

source raw docstring

get-cancellation-token^cljs

(get-cancellation-token external-project)

Returns: HostCancellationToken

**Returns:** `HostCancellationToken`

source raw docstring

get-compiler-options^cljs

(get-compiler-options external-project)

Returns: CompilerOptions

**Returns:** `CompilerOptions`

source raw docstring

get-excluded-files^cljs

(get-excluded-files external-project)

Returns: readonly NormalizedPath[]

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

source raw docstring

get-external-files^cljs

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

source raw docstring

get-language-service^cljs

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

source raw docstring

get-root-files^cljs

(get-root-files external-project)

Returns: NormalizedPath[]

**Returns:** `NormalizedPath[]`

source raw docstring

global-project-errors^cljs

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

source raw 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`

source raw docstring

has-roots?^cljs

(has-roots? external-project)

Returns: boolean

**Returns:** `boolean`

source raw docstring

initial-load-pending^cljs

(initial-load-pending external-project)

Returns: () => boolean

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

source raw docstring

install-package^cljs

(install-package external-project options)

Parameters:

options: InstallPackageOptions

Returns: Promise<ApplyCodeActionCommandResult>

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

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

source raw docstring

js-doc-parsing-mode^cljs

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

Returns: JSDocParsingMode | undefined

**Returns:** `JSDocParsingMode | undefined`

source raw docstring

js-only-project?^cljs

(js-only-project? external-project)

Returns: boolean

**Returns:** `boolean`

source raw docstring

known-types-package-name?^cljs

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

Parameters:

name: string

Returns: boolean

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

**Returns:** `boolean`

source raw docstring

language-service^cljs

(language-service external-project)

Returns: LanguageService

**Returns:** `LanguageService`

source raw docstring

language-service-enabled?^cljs

(language-service-enabled? external-project)

Returns: boolean

**Returns:** `boolean`

source raw docstring

last-reported-file-names^cljs

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

source raw docstring

last-reported-version^cljs

(last-reported-version external-project)

Last version that was reported.

Returns: any

Last version that was reported.

**Returns:** `any`

source raw docstring

log^cljs

(log external-project s)

Parameters:

s: string

Returns: void

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

**Returns:** `void`

source raw docstring

mark-as-dirty^cljs

(mark-as-dirty external-project)

Returns: void

**Returns:** `void`

source raw docstring

missing-files-map^cljs

(missing-files-map external-project)

Returns: any

**Returns:** `any`

source raw docstring

new-line^cljs

(new-line external-project)

Returns: string

**Returns:** `string`

source raw docstring

non-ts-project?^cljs

(non-ts-project? external-project)

Returns: boolean

**Returns:** `boolean`

source raw docstring

or-create-script-info-and-attach-to-project^cljs

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

Returns: any

**Returns:** `any`

source raw docstring

program^cljs

(program external-project)

Returns: any

**Returns:** `any`

source raw docstring

project-errors^cljs

(project-errors external-project)

Returns: Diagnostic[] | undefined

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

source raw docstring

project-kind^cljs

(project-kind external-project)

Returns: ProjectKind

**Returns:** `ProjectKind`

source raw docstring

project-name^cljs

(project-name external-project)

Returns: string

**Returns:** `string`

source raw docstring

project-references^cljs

(project-references external-project)

Returns: readonly ProjectReference[] | undefined

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

source raw docstring

project-service^cljs

(project-service external-project)

Returns: ProjectService

**Returns:** `ProjectService`

source raw docstring

project-version^cljs

(project-version external-project)

Returns: string

**Returns:** `string`

source raw docstring

read-directory^cljs

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

source raw docstring

read-file^cljs

(read-file external-project file-name)

Parameters:

file-name: string

Returns: string | undefined

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

**Returns:** `string | undefined`

source raw docstring

realpath^cljs

(realpath external-project)

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

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

source raw docstring

refresh-diagnostics^cljs

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

source raw docstring

register-file-update^cljs

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

Parameters:

file-name: string

Returns: void

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

**Returns:** `void`

source raw docstring

remove-existing-typings^cljs

(remove-existing-typings external-project include)

Parameters:

include: string[]

Returns: string[]

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

**Returns:** `string[]`

source raw docstring

remove-file^cljs

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

source raw docstring

remove-local-typings-from-type-acquisition^cljs

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

source raw docstring

remove-root^cljs

(remove-root external-project info)

Parameters:

info: ScriptInfo

Returns: void

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

**Returns:** `void`

source raw docstring

root-files^cljs

(root-files external-project)

Returns: any

**Returns:** `any`

source raw docstring

root-files-map^cljs

(root-files-map external-project)

Returns: any

**Returns:** `any`

source raw docstring

root-script-infos^cljs

(root-script-infos external-project)

Returns: ScriptInfo[]

**Returns:** `ScriptInfo[]`

source raw docstring

root?^cljs

(root? external-project info)

Parameters:

info: ScriptInfo

Returns: boolean

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

**Returns:** `boolean`

source raw docstring

script-file-names^cljs

(script-file-names external-project)

Returns: string[]

**Returns:** `string[]`

source raw docstring

script-info^cljs

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

Parameters:

unchecked-file-name: string

Returns: ScriptInfo | undefined

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

**Returns:** `ScriptInfo | undefined`

source raw docstring

script-info-for-normalized-path^cljs

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

Parameters:

file-name: NormalizedPath

Returns: ScriptInfo | undefined

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

**Returns:** `ScriptInfo | undefined`

source raw docstring

script-infos^cljs

(script-infos external-project)

Returns: ScriptInfo[]

**Returns:** `ScriptInfo[]`

source raw docstring

script-kind^cljs

(script-kind external-project file-name)

Parameters:

file-name: string

Returns: ScriptKind

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

**Returns:** `ScriptKind`

source raw docstring

script-snapshot^cljs

(script-snapshot external-project filename)

Parameters:

filename: string

Returns: IScriptSnapshot | undefined

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

**Returns:** `IScriptSnapshot | undefined`

source raw docstring

script-version^cljs

(script-version external-project filename)

Parameters:

filename: string

Returns: string

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

**Returns:** `string`

source raw 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-options^cljs

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

Parameters:

compiler-options: CompilerOptions

Returns: void

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

**Returns:** `void`

source raw 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-files^cljs

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

Returns: any

**Returns:** `any`

source raw 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.

source raw docstring

set-last-reported-version!^cljs

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

Last version that was reported.

Last version that was reported.

source raw 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-errors^cljs

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

source raw 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-acquisition^cljs

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

source raw 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.

source raw docstring

set-watch-options!^cljs

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

source

source-file^cljs

(source-file external-project path)

Parameters:

path: Path

Returns: SourceFile | undefined

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

**Returns:** `SourceFile | undefined`

source raw docstring

trace^cljs

(trace external-project)

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

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

source raw docstring

type-acquisition^cljs

(type-acquisition external-project)

Returns: TypeAcquisition

**Returns:** `TypeAcquisition`

source raw docstring

update-graph-worker^cljs

(update-graph-worker external-project)

Returns: any

**Returns:** `any`

source raw 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.

source raw docstring

updated-file-names^cljs

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

source raw docstring

use-case-sensitive-file-names?^cljs

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

Returns: boolean

**Returns:** `boolean`

source raw docstring

valid-generated-file-watcher^cljs

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

Returns: any

**Returns:** `any`

source raw docstring

watch-options^cljs

(watch-options external-project)

Returns: WatchOptions | undefined

**Returns:** `WatchOptions | undefined`

source raw docstring

watched-missing-file^cljs

(watched-missing-file external-project)

Returns: any

**Returns:** `any`

source raw docstring

write-file^cljs

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

Parameters:

file-name: string
content: string

Returns: void

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

**Returns:** `void`

source raw docstring

`Ctrl`+`k`	Jump to recent docs
`←`	Move to previous article
`→`	Move to next article
`Ctrl`+`/`	Jump to the search field