dots.typescript.semantic-diagnostics-builder-program

Liking cljdoc? Tell your friends :D

ClojureScript only.

all-dependencies
compiler-options
config-file-parsing-diagnostics
current-directory
declaration-diagnostics
emit
global-diagnostics
options-diagnostics
program
semantic-diagnostics
semantic-diagnostics-of-next-affected-file
source-file
source-files
syntactic-diagnostics

The builder that caches the semantic diagnostics for the program and handles the changed files and affected files

The builder that caches the semantic diagnostics for the program and handles the changed files and affected files

raw docstring

all-dependencies^cljs

(all-dependencies semantic-diagnostics-builder-program source-file)

Get all the dependencies of the file

Parameters:

source-file: SourceFile

Returns: readonly string[]

Get all the dependencies of the file

**Parameters:**
- `source-file`: `SourceFile`

**Returns:** `readonly string[]`

source raw docstring

compiler-options^cljs

(compiler-options semantic-diagnostics-builder-program)

Get compiler options of the program

Returns: CompilerOptions

Get compiler options of the program

**Returns:** `CompilerOptions`

source raw docstring

config-file-parsing-diagnostics^cljs

(config-file-parsing-diagnostics semantic-diagnostics-builder-program)

Get the diagnostics from config file parsing

Returns: readonly Diagnostic[]

Get the diagnostics from config file parsing

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

source raw docstring

current-directory^cljs

(current-directory semantic-diagnostics-builder-program)

Get the current directory of the program

Returns: string

Get the current directory of the program

**Returns:** `string`

source raw docstring

declaration-diagnostics^cljs

(declaration-diagnostics semantic-diagnostics-builder-program)

(declaration-diagnostics semantic-diagnostics-builder-program source-file)

(declaration-diagnostics semantic-diagnostics-builder-program
                         source-file
                         cancellation-token)

Get the declaration diagnostics, for all source files if source file is not supplied

Parameters:

source-file: SourceFile | undefined
cancellation-token: CancellationToken | undefined

Returns: readonly DiagnosticWithLocation[]

Get the declaration diagnostics, for all source files if source file is not supplied

**Parameters:**
- `source-file`: `SourceFile | undefined`
- `cancellation-token`: `CancellationToken | undefined`

**Returns:** `readonly DiagnosticWithLocation[]`

source raw docstring

emit^cljs

(emit semantic-diagnostics-builder-program)

(emit semantic-diagnostics-builder-program target-source-file)

(emit semantic-diagnostics-builder-program target-source-file write-file)

(emit semantic-diagnostics-builder-program
      target-source-file
      write-file
      cancellation-token)

(emit semantic-diagnostics-builder-program
      target-source-file
      write-file
      cancellation-token
      emit-only-dts-files?)

(emit semantic-diagnostics-builder-program
      target-source-file
      write-file
      cancellation-token
      emit-only-dts-files?
      custom-transformers)

Emits the JavaScript and declaration files. When targetSource file is specified, emits the files corresponding to that source file, otherwise for the whole program. In case of EmitAndSemanticDiagnosticsBuilderProgram, when targetSourceFile is specified, it is assumed that that file is handled from affected file list. If targetSourceFile is not specified, it will only emit all the affected files instead of whole program

The first of writeFile if provided, writeFile of BuilderProgramHost if provided, writeFile of compiler host in that order would be used to write the files

Parameters:

target-source-file: SourceFile | undefined
write-file: WriteFileCallback | undefined
cancellation-token: CancellationToken | undefined
emit-only-dts-files?: boolean | undefined
custom-transformers: CustomTransformers | undefined

Returns: EmitResult

Emits the JavaScript and declaration files.
When targetSource file is specified, emits the files corresponding to that source file,
otherwise for the whole program.
In case of EmitAndSemanticDiagnosticsBuilderProgram, when targetSourceFile is specified,
it is assumed that that file is handled from affected file list. If targetSourceFile is not specified,
it will only emit all the affected files instead of whole program

The first of writeFile if provided, writeFile of BuilderProgramHost if provided, writeFile of compiler host
in that order would be used to write the files

**Parameters:**
- `target-source-file`: `SourceFile | undefined`
- `write-file`: `WriteFileCallback | undefined`
- `cancellation-token`: `CancellationToken | undefined`
- `emit-only-dts-files?`: `boolean | undefined`
- `custom-transformers`: `CustomTransformers | undefined`

**Returns:** `EmitResult`

source raw docstring

global-diagnostics^cljs

(global-diagnostics semantic-diagnostics-builder-program)

(global-diagnostics semantic-diagnostics-builder-program cancellation-token)

Get the diagnostics that dont belong to any file

Parameters:

cancellation-token: CancellationToken | undefined

Returns: readonly Diagnostic[]

Get the diagnostics that dont belong to any file

**Parameters:**
- `cancellation-token`: `CancellationToken | undefined`

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

source raw docstring

options-diagnostics^cljs

(options-diagnostics semantic-diagnostics-builder-program)

(options-diagnostics semantic-diagnostics-builder-program cancellation-token)

Get the diagnostics for compiler options

Parameters:

cancellation-token: CancellationToken | undefined

Returns: readonly Diagnostic[]

Get the diagnostics for compiler options

**Parameters:**
- `cancellation-token`: `CancellationToken | undefined`

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

source raw docstring

program^cljs

(program semantic-diagnostics-builder-program)

Returns current program

Returns: Program

Returns current program

**Returns:** `Program`

source raw docstring

semantic-diagnostics^cljs

(semantic-diagnostics semantic-diagnostics-builder-program)

(semantic-diagnostics semantic-diagnostics-builder-program source-file)

(semantic-diagnostics semantic-diagnostics-builder-program
                      source-file
                      cancellation-token)

Gets the semantic diagnostics from the program corresponding to this state of file (if provided) or whole program The semantic diagnostics are cached and managed here Note that it is assumed that when asked about semantic diagnostics through this API, the file has been taken out of affected files so it is safe to use cache or get from program and cache the diagnostics In case of SemanticDiagnosticsBuilderProgram if the source file is not provided, it will iterate through all the affected files, to ensure that cache stays valid and yet provide a way to get all semantic diagnostics

Parameters:

source-file: SourceFile | undefined
cancellation-token: CancellationToken | undefined

Returns: readonly Diagnostic[]

Gets the semantic diagnostics from the program corresponding to this state of file (if provided) or whole program
The semantic diagnostics are cached and managed here
Note that it is assumed that when asked about semantic diagnostics through this API,
the file has been taken out of affected files so it is safe to use cache or get from program and cache the diagnostics
In case of SemanticDiagnosticsBuilderProgram if the source file is not provided,
it will iterate through all the affected files, to ensure that cache stays valid and yet provide a way to get all semantic diagnostics

**Parameters:**
- `source-file`: `SourceFile | undefined`
- `cancellation-token`: `CancellationToken | undefined`

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

source raw docstring

semantic-diagnostics-of-next-affected-file^cljs

(semantic-diagnostics-of-next-affected-file
  semantic-diagnostics-builder-program)

(semantic-diagnostics-of-next-affected-file semantic-diagnostics-builder-program
                                            cancellation-token)

(semantic-diagnostics-of-next-affected-file semantic-diagnostics-builder-program
                                            cancellation-token
                                            ignore-source-file)

Gets the semantic diagnostics from the program for the next affected file and caches it Returns undefined if the iteration is complete

Parameters:

cancellation-token: CancellationToken | undefined
ignore-source-file: ((sourceFile: SourceFile) => boolean) | undefined

Returns: AffectedFileResult<readonly Diagnostic[]>

Gets the semantic diagnostics from the program for the next affected file and caches it
Returns undefined if the iteration is complete

**Parameters:**
- `cancellation-token`: `CancellationToken | undefined`
- `ignore-source-file`: `((sourceFile: SourceFile) => boolean) | undefined`

**Returns:** `AffectedFileResult<readonly Diagnostic[]>`

source raw docstring

source-file^cljs

(source-file semantic-diagnostics-builder-program file-name)

Get the source file in the program with file name

Parameters:

file-name: string

Returns: SourceFile | undefined

Get the source file in the program with file name

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

**Returns:** `SourceFile | undefined`

source raw docstring

source-files^cljs

(source-files semantic-diagnostics-builder-program)

Get a list of files in the program

Returns: readonly SourceFile[]

Get a list of files in the program

**Returns:** `readonly SourceFile[]`

source raw docstring

syntactic-diagnostics^cljs

(syntactic-diagnostics semantic-diagnostics-builder-program)

(syntactic-diagnostics semantic-diagnostics-builder-program source-file)

(syntactic-diagnostics semantic-diagnostics-builder-program
                       source-file
                       cancellation-token)

Get the syntax diagnostics, for all source files if source file is not supplied

Parameters:

source-file: SourceFile | undefined
cancellation-token: CancellationToken | undefined

Returns: readonly Diagnostic[]

Get the syntax diagnostics, for all source files if source file is not supplied

**Parameters:**
- `source-file`: `SourceFile | undefined`
- `cancellation-token`: `CancellationToken | undefined`

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

source raw docstring

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

Keyboard shortcuts Report a problem cljdoc on GitHub

× close