The builder that can handle the changes in program and iterate through changed file to emit the files The semantic diagnostics are cached per file and managed by clearing for the changed/affected files
The builder that can handle the changes in program and iterate through changed file to emit the files The semantic diagnostics are cached per file and managed by clearing for the changed/affected files
(all-dependencies emit-and-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[]`
(compiler-options emit-and-semantic-diagnostics-builder-program)
Get compiler options of the program
Returns: CompilerOptions
Get compiler options of the program **Returns:** `CompilerOptions`
(config-file-parsing-diagnostics emit-and-semantic-diagnostics-builder-program)
Get the diagnostics from config file parsing
Returns: readonly Diagnostic[]
Get the diagnostics from config file parsing **Returns:** `readonly Diagnostic[]`
(current-directory emit-and-semantic-diagnostics-builder-program)
Get the current directory of the program
Returns: string
Get the current directory of the program **Returns:** `string`
(declaration-diagnostics emit-and-semantic-diagnostics-builder-program)
(declaration-diagnostics emit-and-semantic-diagnostics-builder-program
source-file)
(declaration-diagnostics emit-and-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[]`
(emit emit-and-semantic-diagnostics-builder-program)
(emit emit-and-semantic-diagnostics-builder-program target-source-file)
(emit emit-and-semantic-diagnostics-builder-program
target-source-file
write-file)
(emit emit-and-semantic-diagnostics-builder-program
target-source-file
write-file
cancellation-token)
(emit emit-and-semantic-diagnostics-builder-program
target-source-file
write-file
cancellation-token
emit-only-dts-files?)
(emit emit-and-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`
(emit-next-affected-file emit-and-semantic-diagnostics-builder-program)
(emit-next-affected-file emit-and-semantic-diagnostics-builder-program
write-file)
(emit-next-affected-file emit-and-semantic-diagnostics-builder-program
write-file
cancellation-token)
(emit-next-affected-file emit-and-semantic-diagnostics-builder-program
write-file
cancellation-token
emit-only-dts-files?)
(emit-next-affected-file emit-and-semantic-diagnostics-builder-program
write-file
cancellation-token
emit-only-dts-files?
custom-transformers)
Emits the next affected file's emit result (EmitResult and sourceFiles emitted) or returns undefined if iteration is complete 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:
write-file
: WriteFileCallback | undefined
cancellation-token
: CancellationToken | undefined
emit-only-dts-files?
: boolean | undefined
custom-transformers
: CustomTransformers | undefined
Returns: AffectedFileResult<EmitResult>
Emits the next affected file's emit result (EmitResult and sourceFiles emitted) or returns undefined if iteration is complete 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:** - `write-file`: `WriteFileCallback | undefined` - `cancellation-token`: `CancellationToken | undefined` - `emit-only-dts-files?`: `boolean | undefined` - `custom-transformers`: `CustomTransformers | undefined` **Returns:** `AffectedFileResult<EmitResult>`
(global-diagnostics emit-and-semantic-diagnostics-builder-program)
(global-diagnostics emit-and-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[]`
(options-diagnostics emit-and-semantic-diagnostics-builder-program)
(options-diagnostics emit-and-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[]`
(program emit-and-semantic-diagnostics-builder-program)
Returns current program
Returns: Program
Returns current program **Returns:** `Program`
(semantic-diagnostics emit-and-semantic-diagnostics-builder-program)
(semantic-diagnostics emit-and-semantic-diagnostics-builder-program source-file)
(semantic-diagnostics emit-and-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[]`
(semantic-diagnostics-of-next-affected-file
emit-and-semantic-diagnostics-builder-program)
(semantic-diagnostics-of-next-affected-file
emit-and-semantic-diagnostics-builder-program
cancellation-token)
(semantic-diagnostics-of-next-affected-file
emit-and-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-file emit-and-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-files emit-and-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[]`
(syntactic-diagnostics emit-and-semantic-diagnostics-builder-program)
(syntactic-diagnostics emit-and-semantic-diagnostics-builder-program
source-file)
(syntactic-diagnostics emit-and-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[]`
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close