Liking cljdoc? Tell your friends :D
ClojureScript only.

dots.typescript.builder-program

Builder to manage the program state changes

Builder to manage the program state changes
raw docstring

all-dependenciescljs

(all-dependencies 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[]`
sourceraw docstring

compiler-optionscljs

(compiler-options builder-program)

Get compiler options of the program

Returns: CompilerOptions

Get compiler options of the program

**Returns:** `CompilerOptions`
sourceraw docstring

config-file-parsing-diagnosticscljs

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

Get the diagnostics from config file parsing

Returns: readonly Diagnostic[]

Get the diagnostics from config file parsing

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

current-directorycljs

(current-directory builder-program)

Get the current directory of the program

Returns: string

Get the current directory of the program

**Returns:** `string`
sourceraw docstring

declaration-diagnosticscljs

(declaration-diagnostics builder-program)
(declaration-diagnostics builder-program source-file)
(declaration-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[]`
sourceraw docstring

emitcljs

(emit builder-program)
(emit builder-program target-source-file)
(emit builder-program target-source-file write-file)
(emit builder-program target-source-file write-file cancellation-token)
(emit builder-program
      target-source-file
      write-file
      cancellation-token
      emit-only-dts-files?)
(emit 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`
sourceraw docstring

global-diagnosticscljs

(global-diagnostics builder-program)
(global-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[]`
sourceraw docstring

options-diagnosticscljs

(options-diagnostics builder-program)
(options-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[]`
sourceraw docstring

programcljs

(program builder-program)

Returns current program

Returns: Program

Returns current program

**Returns:** `Program`
sourceraw docstring

semantic-diagnosticscljs

(semantic-diagnostics builder-program)
(semantic-diagnostics builder-program source-file)
(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[]`
sourceraw docstring

source-filecljs

(source-file 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`
sourceraw docstring

source-filescljs

(source-files builder-program)

Get a list of files in the program

Returns: readonly SourceFile[]

Get a list of files in the program

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

syntactic-diagnosticscljs

(syntactic-diagnostics builder-program)
(syntactic-diagnostics builder-program source-file)
(syntactic-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[]`
sourceraw docstring

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

Keyboard shortcutsReport a problemcljdoc on GitHub
× close