If a file is opened, the server will look for a tsconfig (or jsconfig) and if successful create a ConfiguredProject for it. Otherwise it will create an InferredProject.
If a file is opened, the server will look for a tsconfig (or jsconfig) and if successful create a ConfiguredProject for it. Otherwise it will create an InferredProject.
(add-missing-file-root configured-project file-name)Parameters:
file-name: NormalizedPathReturns: void
**Parameters:** - `file-name`: `NormalizedPath` **Returns:** `void`
(add-missing-file-watcher configured-project)Returns: any
**Returns:** `any`
(add-root configured-project info)(add-root configured-project info file-name)Parameters:
info: ScriptInfofile-name: NormalizedPath | undefinedReturns: void
**Parameters:** - `info`: `ScriptInfo` - `file-name`: `NormalizedPath | undefined` **Returns:** `void`
(all-project-errors configured-project)Get all the project errors
Returns: readonly Diagnostic[]
Get all the project errors **Returns:** `readonly Diagnostic[]`
(builder-state configured-project)Returns: any
**Returns:** `any`
(cancellation-token configured-project)Returns: any
**Returns:** `any`
(canonical-config-file-path configured-project)Returns: NormalizedPath
**Returns:** `NormalizedPath`
(clear-generated-file-watch configured-project)Returns: any
**Returns:** `any`
(compilation-settings configured-project)Returns: CompilerOptions
**Returns:** `CompilerOptions`
(compile-on-save-affected-file-list configured-project script-info)Parameters:
script-info: ScriptInfoReturns: string[]
**Parameters:** - `script-info`: `ScriptInfo` **Returns:** `string[]`
(compile-on-save-enabled? configured-project)Returns: boolean
**Returns:** `boolean`
(compiler-options configured-project)Returns: any
**Returns:** `any`
(config-file-path configured-project)Returns: NormalizedPath
**Returns:** `NormalizedPath`
(contains-file? configured-project filename)(contains-file? configured-project filename require-open?)Parameters:
filename: NormalizedPathrequire-open?: boolean | undefinedReturns: boolean
**Parameters:** - `filename`: `NormalizedPath` - `require-open?`: `boolean | undefined` **Returns:** `boolean`
(contains-script-info? configured-project info)Parameters:
info: ScriptInfoReturns: boolean
**Parameters:** - `info`: `ScriptInfo` **Returns:** `boolean`
(create-generated-file-watcher configured-project)Returns: any
**Returns:** `any`
(current-directory configured-project)Returns: string
**Returns:** `string`
(default-lib-file-name configured-project)Returns: string
**Returns:** `string`
(detach-script-info-from-project configured-project)Returns: any
**Returns:** `any`
(detach-script-info-if-not-root configured-project)Returns: any
**Returns:** `any`
(directories configured-project path)Parameters:
path: stringReturns: string[]
**Parameters:** - `path`: `string` **Returns:** `string[]`
(directory-exists? configured-project path)Parameters:
path: stringReturns: boolean
**Parameters:** - `path`: `string` **Returns:** `boolean`
(disable-language-service configured-project)(disable-language-service configured-project last-file-exceeded-program-size)Parameters:
last-file-exceeded-program-size: string | undefinedReturns: void
**Parameters:** - `last-file-exceeded-program-size`: `string | undefined` **Returns:** `void`
(document-registry configured-project)Returns: any
**Returns:** `any`
(effective-type-roots configured-project)Returns: string[]
**Returns:** `string[]`
(emit-file configured-project script-info write-file)Returns true if emit was conducted
Parameters:
script-info: ScriptInfowrite-file: (path: string, data: string, writeByteOrderMark?: boolean | undefined) => voidReturns: EmitResult
Returns true if emit was conducted **Parameters:** - `script-info`: `ScriptInfo` - `write-file`: `(path: string, data: string, writeByteOrderMark?: boolean | undefined) => void` **Returns:** `EmitResult`
(enable-global-plugins configured-project options)Parameters:
options: CompilerOptionsReturns: void
**Parameters:** - `options`: `CompilerOptions` **Returns:** `void`
(enable-language-service configured-project)Returns: void
**Returns:** `void`
(enable-plugin configured-project plugin-config-entry search-paths)Parameters:
plugin-config-entry: PluginImportsearch-paths: string[]Returns: void
**Parameters:** - `plugin-config-entry`: `PluginImport` - `search-paths`: `string[]` **Returns:** `void`
(error configured-project s)Parameters:
s: stringReturns: void
**Parameters:** - `s`: `string` **Returns:** `void`
(excluded-files configured-project)Returns: readonly NormalizedPath[]
**Returns:** `readonly NormalizedPath[]`
(external-files configured-project)Returns: any
**Returns:** `any`
(external-project-ref-count configured-project)Ref count to the project when opened from external project
Returns: any
Ref count to the project when opened from external project **Returns:** `any`
(file-exists? configured-project file)Parameters:
file: stringReturns: boolean
**Parameters:** - `file`: `string` **Returns:** `boolean`
(file-names configured-project)(file-names configured-project exclude-files-from-external-libraries?)(file-names configured-project
exclude-files-from-external-libraries?
exclude-config-files?)Parameters:
exclude-files-from-external-libraries?: boolean | undefinedexclude-config-files?: boolean | undefinedReturns: NormalizedPath[]
**Parameters:** - `exclude-files-from-external-libraries?`: `boolean | undefined` - `exclude-config-files?`: `boolean | undefined` **Returns:** `NormalizedPath[]`
(files-to-string configured-project write-project-file-names?)Parameters:
write-project-file-names?: booleanReturns: string
**Parameters:** - `write-project-file-names?`: `boolean` **Returns:** `string`
(generated-files-map configured-project)Returns: any
**Returns:** `any`
(get-cancellation-token configured-project)Returns: HostCancellationToken
**Returns:** `HostCancellationToken`
(get-compiler-options configured-project)Returns: CompilerOptions
**Returns:** `CompilerOptions`
(get-external-files configured-project)(get-external-files configured-project update-level)Parameters:
update-level: ProgramUpdateLevel | undefinedReturns: SortedReadonlyArray<string>
**Parameters:** - `update-level`: `ProgramUpdateLevel | undefined` **Returns:** `SortedReadonlyArray<string>`
(get-language-service configured-project)(get-language-service configured-project ensure-synchronized?)Parameters:
ensure-synchronized?: boolean | undefinedReturns: LanguageService
**Parameters:** - `ensure-synchronized?`: `boolean | undefined` **Returns:** `LanguageService`
(get-project-references configured-project)Returns: readonly ProjectReference[] | undefined
**Returns:** `readonly ProjectReference[] | undefined`
(get-root-files configured-project)Returns: NormalizedPath[]
**Returns:** `NormalizedPath[]`
(global-project-errors configured-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[]`
(has-config-file? configured-project config-file-path)Parameters:
config-file-path: NormalizedPathReturns: boolean
**Parameters:** - `config-file-path`: `NormalizedPath` **Returns:** `boolean`
(has-roots? configured-project)Returns: boolean
**Returns:** `boolean`
(initial-load-pending configured-project)Returns: () => boolean
**Returns:** `() => boolean`
(install-package configured-project options)Parameters:
options: InstallPackageOptionsReturns: Promise<ApplyCodeActionCommandResult>
**Parameters:** - `options`: `InstallPackageOptions` **Returns:** `Promise<ApplyCodeActionCommandResult>`
(js-doc-parsing-mode configured-project)Returns: JSDocParsingMode | undefined
**Returns:** `JSDocParsingMode | undefined`
(js-only-project? configured-project)Returns: boolean
**Returns:** `boolean`
(known-types-package-name? configured-project name)Parameters:
name: stringReturns: boolean
**Parameters:** - `name`: `string` **Returns:** `boolean`
(language-service configured-project)Returns: LanguageService
**Returns:** `LanguageService`
(language-service-enabled? configured-project)Returns: boolean
**Returns:** `boolean`
(last-reported-file-names configured-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`
(last-reported-version configured-project)Last version that was reported.
Returns: any
Last version that was reported. **Returns:** `any`
(log configured-project s)Parameters:
s: stringReturns: void
**Parameters:** - `s`: `string` **Returns:** `void`
(mark-as-dirty configured-project)Returns: void
**Returns:** `void`
(missing-files-map configured-project)Returns: any
**Returns:** `any`
(non-ts-project? configured-project)Returns: boolean
**Returns:** `boolean`
(or-create-script-info-and-attach-to-project configured-project)Returns: any
**Returns:** `any`
(project-errors configured-project)Returns: Diagnostic[] | undefined
**Returns:** `Diagnostic[] | undefined`
(project-kind configured-project)Returns: ProjectKind
**Returns:** `ProjectKind`
(project-name configured-project)Returns: string
**Returns:** `string`
(project-references configured-project)Returns: any
**Returns:** `any`
(project-service configured-project)Returns: ProjectService
**Returns:** `ProjectService`
(project-version configured-project)Returns: string
**Returns:** `string`
(read-directory configured-project path)(read-directory configured-project path extensions)(read-directory configured-project path extensions exclude)(read-directory configured-project path extensions exclude include)(read-directory configured-project path extensions exclude include depth)Parameters:
path: stringextensions: readonly string[] | undefinedexclude: readonly string[] | undefinedinclude: readonly string[] | undefineddepth: number | undefinedReturns: string[]
**Parameters:** - `path`: `string` - `extensions`: `readonly string[] | undefined` - `exclude`: `readonly string[] | undefined` - `include`: `readonly string[] | undefined` - `depth`: `number | undefined` **Returns:** `string[]`
(read-file configured-project file-name)Parameters:
file-name: stringReturns: string | undefined
**Parameters:** - `file-name`: `string` **Returns:** `string | undefined`
(realpath configured-project)Returns: ((path: string) => string) | undefined
**Returns:** `((path: string) => string) | undefined`
(refresh-diagnostics configured-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`
(register-file-update configured-project file-name)Parameters:
file-name: stringReturns: void
**Parameters:** - `file-name`: `string` **Returns:** `void`
(remove-existing-typings configured-project include)Parameters:
include: string[]Returns: string[]
**Parameters:** - `include`: `string[]` **Returns:** `string[]`
(remove-file configured-project info file-exists? detach-from-project?)Parameters:
info: ScriptInfofile-exists?: booleandetach-from-project?: booleanReturns: void
**Parameters:** - `info`: `ScriptInfo` - `file-exists?`: `boolean` - `detach-from-project?`: `boolean` **Returns:** `void`
(remove-local-typings-from-type-acquisition configured-project
new-type-acquisition)Parameters:
new-type-acquisition: TypeAcquisitionReturns: TypeAcquisition
**Parameters:** - `new-type-acquisition`: `TypeAcquisition` **Returns:** `TypeAcquisition`
(remove-root configured-project info)Parameters:
info: ScriptInfoReturns: void
**Parameters:** - `info`: `ScriptInfo` **Returns:** `void`
(root-files-map configured-project)Returns: any
**Returns:** `any`
(root-script-infos configured-project)Returns: ScriptInfo[]
**Returns:** `ScriptInfo[]`
(root? configured-project info)Parameters:
info: ScriptInfoReturns: boolean
**Parameters:** - `info`: `ScriptInfo` **Returns:** `boolean`
(script-file-names configured-project)Returns: string[]
**Returns:** `string[]`
(script-info configured-project unchecked-file-name)Parameters:
unchecked-file-name: stringReturns: ScriptInfo | undefined
**Parameters:** - `unchecked-file-name`: `string` **Returns:** `ScriptInfo | undefined`
(script-info-for-normalized-path configured-project file-name)Parameters:
file-name: NormalizedPathReturns: ScriptInfo | undefined
**Parameters:** - `file-name`: `NormalizedPath` **Returns:** `ScriptInfo | undefined`
(script-infos configured-project)Returns: ScriptInfo[]
**Returns:** `ScriptInfo[]`
(script-kind configured-project file-name)Parameters:
file-name: stringReturns: ScriptKind
**Parameters:** - `file-name`: `string` **Returns:** `ScriptKind`
(script-snapshot configured-project filename)Parameters:
filename: stringReturns: IScriptSnapshot | undefined
**Parameters:** - `filename`: `string` **Returns:** `IScriptSnapshot | undefined`
(script-version configured-project filename)Parameters:
filename: stringReturns: string
**Parameters:** - `filename`: `string` **Returns:** `string`
(set-compiler-options configured-project compiler-options)Parameters:
compiler-options: CompilerOptionsReturns: void
**Parameters:** - `compiler-options`: `CompilerOptions` **Returns:** `void`
(set-create-generated-file-watcher! configured-project value)(set-detach-script-info-from-project! configured-project value)(set-detach-script-info-if-not-root! configured-project value)(set-external-project-ref-count! configured-project value)Ref count to the project when opened from external project
Ref count to the project when opened from external project
(set-get-or-create-script-info-and-attach-to-project! configured-project value)(set-internal-compiler-options-for-emitting-js-files configured-project)Returns: any
**Returns:** `any`
(set-is-valid-generated-file-watcher! configured-project value)(set-last-reported-file-names! configured-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.
(set-last-reported-version! configured-project value)Last version that was reported.
Last version that was reported.
(set-project-errors configured-project project-errors)Parameters:
project-errors: Diagnostic[]Returns: void
**Parameters:** - `project-errors`: `Diagnostic[]` **Returns:** `void`
(set-set-internal-compiler-options-for-emitting-js-files! configured-project
value)(set-type-acquisition configured-project)(set-type-acquisition configured-project new-type-acquisition)Parameters:
new-type-acquisition: TypeAcquisition | undefinedReturns: void
**Parameters:** - `new-type-acquisition`: `TypeAcquisition | undefined` **Returns:** `void`
(set-updated-file-names! configured-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-file configured-project path)Parameters:
path: PathReturns: SourceFile | undefined
**Parameters:** - `path`: `Path` **Returns:** `SourceFile | undefined`
(trace configured-project)Returns: ((s: string) => void) | undefined
**Returns:** `((s: string) => void) | undefined`
(type-acquisition configured-project)Returns: TypeAcquisition
**Returns:** `TypeAcquisition`
(update-graph-worker configured-project)Returns: any
**Returns:** `any`
(update-graph? configured-project)If the project has reload from disk pending, it reloads (and then updates graph as part of that) instead of just updating the graph
Returns: boolean - : true if set of files in the project stays the same and false - otherwise.
If the project has reload from disk pending, it reloads (and then updates graph as part of that) instead of just updating the graph **Returns:** `boolean` - : true if set of files in the project stays the same and false - otherwise.
(update-references configured-project)(update-references configured-project refs)Parameters:
refs: readonly ProjectReference[] | undefinedReturns: void
**Parameters:** - `refs`: `readonly ProjectReference[] | undefined` **Returns:** `void`
(updated-file-names configured-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`
(use-case-sensitive-file-names? configured-project)Returns: boolean
**Returns:** `boolean`
(valid-generated-file-watcher configured-project)Returns: any
**Returns:** `any`
(watch-options configured-project)Returns: WatchOptions | undefined
**Returns:** `WatchOptions | undefined`
(watched-missing-file configured-project)Returns: any
**Returns:** `any`
(write-file configured-project file-name content)Parameters:
file-name: stringcontent: stringReturns: void
**Parameters:** - `file-name`: `string` - `content`: `string` **Returns:** `void`
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |