Liking cljdoc? Tell your friends :D
ClojureScript only.

dots.typescript.server.project


add-missing-file-rootcljs

(add-missing-file-root 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 project)

Returns: any

**Returns:** `any`
sourceraw docstring

add-rootcljs

(add-root project info)
(add-root 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 project)

Get all the project errors

Returns: readonly Diagnostic[]

Get all the project errors

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

builder-statecljs

(builder-state project)

Returns: any

**Returns:** `any`
sourceraw docstring

cancellation-tokencljs

(cancellation-token project)

Returns: any

**Returns:** `any`
sourceraw docstring

clear-generated-file-watchcljs

(clear-generated-file-watch project)

Returns: any

**Returns:** `any`
sourceraw docstring

closecljs

(close project)

Returns: void

**Returns:** `void`
sourceraw docstring

closed?cljs

(closed? project)

Returns: boolean

**Returns:** `boolean`
sourceraw docstring

compilation-settingscljs

(compilation-settings project)

Returns: CompilerOptions

**Returns:** `CompilerOptions`
sourceraw docstring

compile-on-save-affected-file-listcljs

(compile-on-save-affected-file-list 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? project)

Returns: boolean

**Returns:** `boolean`
sourceraw docstring

compiler-optionscljs

(compiler-options project)

Returns: any

**Returns:** `any`
sourceraw docstring

contains-file?cljs

(contains-file? project filename)
(contains-file? 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? project info)

Parameters:

  • info: ScriptInfo

Returns: boolean

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

**Returns:** `boolean`
sourceraw docstring

create-generated-file-watchercljs

(create-generated-file-watcher project)

Returns: any

**Returns:** `any`
sourceraw docstring

current-directorycljs

(current-directory project)

Returns: string

**Returns:** `string`
sourceraw docstring

default-lib-file-namecljs

(default-lib-file-name project)

Returns: string

**Returns:** `string`
sourceraw docstring

detach-script-info-from-projectcljs

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

Returns: any

**Returns:** `any`
sourceraw docstring

detach-script-info-if-not-rootcljs

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

Returns: any

**Returns:** `any`
sourceraw docstring

directoriescljs

(directories project path)

Parameters:

  • path: string

Returns: string[]

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

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

directory-exists?cljs

(directory-exists? project path)

Parameters:

  • path: string

Returns: boolean

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

**Returns:** `boolean`
sourceraw docstring

disable-language-servicecljs

(disable-language-service project)
(disable-language-service 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 project)

Returns: any

**Returns:** `any`
sourceraw docstring

emit-filecljs

(emit-file 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 project options)

Parameters:

  • options: CompilerOptions

Returns: void

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

**Returns:** `void`
sourceraw docstring

enable-language-servicecljs

(enable-language-service project)

Returns: void

**Returns:** `void`
sourceraw docstring

enable-plugincljs

(enable-plugin 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 project s)

Parameters:

  • s: string

Returns: void

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

**Returns:** `void`
sourceraw docstring

excluded-filescljs

(excluded-files project)

Returns: readonly NormalizedPath[]

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

external-filescljs

(external-files project)

Returns: any

**Returns:** `any`
sourceraw docstring

file-exists?cljs

(file-exists? project file)

Parameters:

  • file: string

Returns: boolean

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

**Returns:** `boolean`
sourceraw docstring

file-namescljs

(file-names project)
(file-names project exclude-files-from-external-libraries?)
(file-names 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 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 project)

Returns: any

**Returns:** `any`
sourceraw docstring

get-cancellation-tokencljs

(get-cancellation-token project)

Returns: HostCancellationToken

**Returns:** `HostCancellationToken`
sourceraw docstring

get-compiler-optionscljs

(get-compiler-options project)

Returns: CompilerOptions

**Returns:** `CompilerOptions`
sourceraw docstring

get-external-filescljs

(get-external-files project)
(get-external-files 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 project)
(get-language-service 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 project)

Returns: NormalizedPath[]

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

global-project-errorscljs

(global-project-errors 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? 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? project)

Returns: boolean

**Returns:** `boolean`
sourceraw docstring

initial-load-pendingcljs

(initial-load-pending project)

Returns: () => boolean

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

install-packagecljs

(install-package project options)

Parameters:

  • options: InstallPackageOptions

Returns: Promise<ApplyCodeActionCommandResult>

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

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

js-doc-parsing-modecljs

(js-doc-parsing-mode project)

Returns: JSDocParsingMode | undefined

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

js-only-project?cljs

(js-only-project? project)

Returns: boolean

**Returns:** `boolean`
sourceraw docstring

known-types-package-name?cljs

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

Parameters:

  • name: string

Returns: boolean

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

**Returns:** `boolean`
sourceraw docstring

language-servicecljs

(language-service project)

Returns: LanguageService

**Returns:** `LanguageService`
sourceraw docstring

language-service-enabled?cljs

(language-service-enabled? project)

Returns: boolean

**Returns:** `boolean`
sourceraw docstring

last-reported-file-namescljs

(last-reported-file-names 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 project)

Last version that was reported.

Returns: any

Last version that was reported.

**Returns:** `any`
sourceraw docstring

logcljs

(log project s)

Parameters:

  • s: string

Returns: void

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

**Returns:** `void`
sourceraw docstring

mark-as-dirtycljs

(mark-as-dirty project)

Returns: void

**Returns:** `void`
sourceraw docstring

missing-files-mapcljs

(missing-files-map project)

Returns: any

**Returns:** `any`
sourceraw docstring

new-linecljs

(new-line project)

Returns: string

**Returns:** `string`
sourceraw docstring

non-ts-project?cljs

(non-ts-project? project)

Returns: boolean

**Returns:** `boolean`
sourceraw docstring

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

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

Returns: any

**Returns:** `any`
sourceraw docstring

programcljs

(program project)

Returns: any

**Returns:** `any`
sourceraw docstring

project-errorscljs

(project-errors project)

Returns: Diagnostic[] | undefined

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

project-kindcljs

(project-kind project)

Returns: ProjectKind

**Returns:** `ProjectKind`
sourceraw docstring

project-namecljs

(project-name project)

Returns: string

**Returns:** `string`
sourceraw docstring

project-referencescljs

(project-references project)

Returns: readonly ProjectReference[] | undefined

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

project-servicecljs

(project-service project)

Returns: ProjectService

**Returns:** `ProjectService`
sourceraw docstring

project-versioncljs

(project-version project)

Returns: string

**Returns:** `string`
sourceraw docstring

read-directorycljs

(read-directory project path)
(read-directory project path extensions)
(read-directory project path extensions exclude)
(read-directory project path extensions exclude include)
(read-directory 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 project file-name)

Parameters:

  • file-name: string

Returns: string | undefined

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

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

realpathcljs

(realpath project)

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

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

refresh-diagnosticscljs

(refresh-diagnostics 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 project file-name)

Parameters:

  • file-name: string

Returns: void

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

**Returns:** `void`
sourceraw docstring

remove-existing-typingscljs

(remove-existing-typings project include)

Parameters:

  • include: string[]

Returns: string[]

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

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

remove-filecljs

(remove-file 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 project new-type-acquisition)

Parameters:

  • new-type-acquisition: TypeAcquisition

Returns: TypeAcquisition

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

**Returns:** `TypeAcquisition`
sourceraw docstring

remove-rootcljs

(remove-root project info)

Parameters:

  • info: ScriptInfo

Returns: void

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

**Returns:** `void`
sourceraw docstring

resolve-modulecljs

(resolve-module module-name initial-dir host log)

Parameters:

  • module-name: string
  • initial-dir: string
  • host: ServerHost
  • log: (message: string) => void

Returns: {} | undefined

**Parameters:**
- `module-name`: `string`
- `initial-dir`: `string`
- `host`: `ServerHost`
- `log`: `(message: string) => void`

**Returns:** `{} | undefined`
sourceraw docstring

root-filescljs

(root-files project)

Returns: any

**Returns:** `any`
sourceraw docstring

root-files-mapcljs

(root-files-map project)

Returns: any

**Returns:** `any`
sourceraw docstring

root-script-infoscljs

(root-script-infos project)

Returns: ScriptInfo[]

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

root?cljs

(root? project info)

Parameters:

  • info: ScriptInfo

Returns: boolean

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

**Returns:** `boolean`
sourceraw docstring

script-file-namescljs

(script-file-names project)

Returns: string[]

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

script-infocljs

(script-info 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 project file-name)

Parameters:

  • file-name: NormalizedPath

Returns: ScriptInfo | undefined

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

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

script-infoscljs

(script-infos project)

Returns: ScriptInfo[]

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

script-kindcljs

(script-kind project file-name)

Parameters:

  • file-name: string

Returns: ScriptKind

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

**Returns:** `ScriptKind`
sourceraw docstring

script-snapshotcljs

(script-snapshot project filename)

Parameters:

  • filename: string

Returns: IScriptSnapshot | undefined

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

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

script-versioncljs

(script-version 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! project value)
source

set-builder-state!cljs

(set-builder-state! project value)
source

set-clear-generated-file-watch!cljs

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

set-compile-on-save-enabled!cljs

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

set-compiler-optionscljs

(set-compiler-options project compiler-options)

Parameters:

  • compiler-options: CompilerOptions

Returns: void

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

**Returns:** `void`
sourceraw docstring

set-compiler-options!cljs

(set-compiler-options! project value)
source

set-create-generated-file-watcher!cljs

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

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

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

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

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

set-document-registry!cljs

(set-document-registry! project value)
source

set-external-files!cljs

(set-external-files! project value)
source

set-generated-files-map!cljs

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

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

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

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

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

Returns: any

**Returns:** `any`
sourceraw docstring

set-is-initial-load-pending!cljs

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

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

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

set-is-watched-missing-file!cljs

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

set-language-service!cljs

(set-language-service! project value)
source

set-language-service-enabled!cljs

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

set-last-reported-file-names!cljs

(set-last-reported-file-names! 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! project value)

Last version that was reported.

Last version that was reported.
sourceraw docstring

set-missing-files-map!cljs

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

set-program!cljs

(set-program! project value)
source

set-project-errorscljs

(set-project-errors project)
(set-project-errors 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! project value)
source

set-root-files!cljs

(set-root-files! project value)
source

set-root-files-map!cljs

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

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

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

set-type-acquisitioncljs

(set-type-acquisition project)
(set-type-acquisition 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! project value)
source

set-updated-file-names!cljs

(set-updated-file-names! 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! project value)
source

source-filecljs

(source-file project path)

Parameters:

  • path: Path

Returns: SourceFile | undefined

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

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

tracecljs

(trace project)

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

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

type-acquisitioncljs

(type-acquisition project)

Returns: TypeAcquisition

**Returns:** `TypeAcquisition`
sourceraw docstring

update-graph-workercljs

(update-graph-worker project)

Returns: any

**Returns:** `any`
sourceraw docstring

update-graph?cljs

(update-graph? project)

Updates set of files that contribute to this project

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

Updates set of files that contribute to this project

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

updated-file-namescljs

(updated-file-names 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? project)

Returns: boolean

**Returns:** `boolean`
sourceraw docstring

valid-generated-file-watchercljs

(valid-generated-file-watcher project)

Returns: any

**Returns:** `any`
sourceraw docstring

watch-optionscljs

(watch-options project)

Returns: WatchOptions | undefined

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

watched-missing-filecljs

(watched-missing-file project)

Returns: any

**Returns:** `any`
sourceraw docstring

write-filecljs

(write-file 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