Logo Xantham

CompilerOptions Type

CompilerOptions contains the compiler options exposed by the API.

Record fields

Record Field Description

AllowArbitraryExtensions

Full Usage: AllowArbitraryExtensions

Field type: bool voption
Field type: bool voption

AllowImportingTsExtensions

Full Usage: AllowImportingTsExtensions

Field type: bool voption
Field type: bool voption

AllowJs

Full Usage: AllowJs

Field type: bool voption
Field type: bool voption

AllowNonTsExtensions

Full Usage: AllowNonTsExtensions

Field type: bool voption
Field type: bool voption

AllowUmdGlobalAccess

Full Usage: AllowUmdGlobalAccess

Field type: bool voption
Field type: bool voption

AllowUnreachableCode

Full Usage: AllowUnreachableCode

Field type: bool voption
Field type: bool voption

AllowUnusedLabels

Full Usage: AllowUnusedLabels

Field type: bool voption
Field type: bool voption

AssumeChangesOnlyAffectDirectDependencies

Full Usage: AssumeChangesOnlyAffectDirectDependencies

Field type: bool voption
Field type: bool voption

CheckJs

Full Usage: CheckJs

Field type: bool voption
Field type: bool voption

Composite

Full Usage: Composite

Field type: bool voption
Field type: bool voption

ConfigFilePath

Full Usage: ConfigFilePath

Field type: string voption

Internal fields

Field type: string voption

CustomConditions

Full Usage: CustomConditions

Field type: string[] voption
Field type: string[] voption

Declaration

Full Usage: Declaration

Field type: bool voption
Field type: bool voption

DeclarationDir

Full Usage: DeclarationDir

Field type: string voption
Field type: string voption

DeclarationMap

Full Usage: DeclarationMap

Field type: bool voption
Field type: bool voption

DeduplicatePackages

Full Usage: DeduplicatePackages

Field type: bool voption
Field type: bool voption

DisableReferencedProjectLoad

Full Usage: DisableReferencedProjectLoad

Field type: bool voption
Field type: bool voption

DisableSizeLimit

Full Usage: DisableSizeLimit

Field type: bool voption
Field type: bool voption

DisableSolutionSearching

Full Usage: DisableSolutionSearching

Field type: bool voption
Field type: bool voption

DisableSourceOfProjectReferenceRedirect

Full Usage: DisableSourceOfProjectReferenceRedirect

Field type: bool voption
Field type: bool voption

EmitBOM

Full Usage: EmitBOM

Field type: bool voption
Field type: bool voption

EmitDeclarationOnly

Full Usage: EmitDeclarationOnly

Field type: bool voption
Field type: bool voption

EmitDecoratorMetadata

Full Usage: EmitDecoratorMetadata

Field type: bool voption
Field type: bool voption

ErasableSyntaxOnly

Full Usage: ErasableSyntaxOnly

Field type: bool voption
Field type: bool voption

ExactOptionalPropertyTypes

Full Usage: ExactOptionalPropertyTypes

Field type: bool voption
Field type: bool voption

ExperimentalDecorators

Full Usage: ExperimentalDecorators

Field type: bool voption
Field type: bool voption

ForceConsistentCasingInFileNames

Full Usage: ForceConsistentCasingInFileNames

Field type: bool voption
Field type: bool voption

IgnoreConfig

Full Usage: IgnoreConfig

Field type: bool voption
Field type: bool voption

IgnoreDeprecations

Full Usage: IgnoreDeprecations

Field type: string voption
Field type: string voption

ImportHelpers

Full Usage: ImportHelpers

Field type: bool voption
Field type: bool voption

Incremental

Full Usage: Incremental

Field type: bool voption
Field type: bool voption

Init

Full Usage: Init

Field type: bool voption
Field type: bool voption

InlineSourceMap

Full Usage: InlineSourceMap

Field type: bool voption
Field type: bool voption

InlineSources

Full Usage: InlineSources

Field type: bool voption
Field type: bool voption

IsolatedDeclarations

Full Usage: IsolatedDeclarations

Field type: bool voption
Field type: bool voption

IsolatedModules

Full Usage: IsolatedModules

Field type: bool voption
Field type: bool voption

Jsx

Full Usage: Jsx

Field type: JsxEmit voption
Field type: JsxEmit voption

JsxFactory

Full Usage: JsxFactory

Field type: string voption
Field type: string voption

JsxFragmentFactory

Full Usage: JsxFragmentFactory

Field type: string voption
Field type: string voption

JsxImportSource

Full Usage: JsxImportSource

Field type: string voption
Field type: string voption

Lib

Full Usage: Lib

Field type: string[] voption
Field type: string[] voption

LibReplacement

Full Usage: LibReplacement

Field type: bool voption
Field type: bool voption

Locale

Full Usage: Locale

Field type: string voption
Field type: string voption

MapRoot

Full Usage: MapRoot

Field type: string voption
Field type: string voption

MaxNodeModuleJsDepth

Full Usage: MaxNodeModuleJsDepth

Field type: int voption
Field type: int voption

Module

Full Usage: Module

Field type: ModuleKind voption
Field type: ModuleKind voption

ModuleDetection

Full Usage: ModuleDetection

Field type: ModuleDetectionKind voption
Field type: ModuleDetectionKind voption

ModuleResolution

Full Usage: ModuleResolution

Field type: ModuleResolutionKind voption
Field type: ModuleResolutionKind voption

ModuleSuffixes

Full Usage: ModuleSuffixes

Field type: string[] voption
Field type: string[] voption

NewLine

Full Usage: NewLine

Field type: NewLineKind voption
Field type: NewLineKind voption

NoCheck

Full Usage: NoCheck

Field type: bool voption
Field type: bool voption

NoEmit

Full Usage: NoEmit

Field type: bool voption
Field type: bool voption

NoEmitHelpers

Full Usage: NoEmitHelpers

Field type: bool voption
Field type: bool voption

NoEmitOnError

Full Usage: NoEmitOnError

Field type: bool voption
Field type: bool voption

NoErrorTruncation

Full Usage: NoErrorTruncation

Field type: bool voption
Field type: bool voption

NoFallthroughCasesInSwitch

Full Usage: NoFallthroughCasesInSwitch

Field type: bool voption
Field type: bool voption

NoImplicitAny

Full Usage: NoImplicitAny

Field type: bool voption
Field type: bool voption

NoImplicitOverride

Full Usage: NoImplicitOverride

Field type: bool voption
Field type: bool voption

NoImplicitReturns

Full Usage: NoImplicitReturns

Field type: bool voption
Field type: bool voption

NoImplicitThis

Full Usage: NoImplicitThis

Field type: bool voption
Field type: bool voption

NoLib

Full Usage: NoLib

Field type: bool voption
Field type: bool voption

NoPropertyAccessFromIndexSignature

Full Usage: NoPropertyAccessFromIndexSignature

Field type: bool voption
Field type: bool voption

NoResolve

Full Usage: NoResolve

Field type: bool voption
Field type: bool voption

NoUncheckedIndexedAccess

Full Usage: NoUncheckedIndexedAccess

Field type: bool voption
Field type: bool voption

NoUncheckedSideEffectImports

Full Usage: NoUncheckedSideEffectImports

Field type: bool voption
Field type: bool voption

NoUnusedLocals

Full Usage: NoUnusedLocals

Field type: bool voption
Field type: bool voption

NoUnusedParameters

Full Usage: NoUnusedParameters

Field type: bool voption
Field type: bool voption

OutDir

Full Usage: OutDir

Field type: string voption
Field type: string voption

Paths

Full Usage: Paths

Field type: JsonObject
Field type: JsonObject

PreserveConstEnums

Full Usage: PreserveConstEnums

Field type: bool voption
Field type: bool voption

PreserveSymlinks

Full Usage: PreserveSymlinks

Field type: bool voption
Field type: bool voption

Project

Full Usage: Project

Field type: string voption
Field type: string voption

ReactNamespace

Full Usage: ReactNamespace

Field type: string voption
Field type: string voption

RemoveComments

Full Usage: RemoveComments

Field type: bool voption
Field type: bool voption

ResolveJsonModule

Full Usage: ResolveJsonModule

Field type: bool voption
Field type: bool voption

ResolvePackageJsonExports

Full Usage: ResolvePackageJsonExports

Field type: bool voption
Field type: bool voption

ResolvePackageJsonImports

Full Usage: ResolvePackageJsonImports

Field type: bool voption
Field type: bool voption

RewriteRelativeImportExtensions

Full Usage: RewriteRelativeImportExtensions

Field type: bool voption
Field type: bool voption

RootDir

Full Usage: RootDir

Field type: string voption
Field type: string voption

RootDirs

Full Usage: RootDirs

Field type: string[] voption
Field type: string[] voption

SkipDefaultLibCheck

Full Usage: SkipDefaultLibCheck

Field type: bool voption
Field type: bool voption

SkipLibCheck

Full Usage: SkipLibCheck

Field type: bool voption
Field type: bool voption

SourceMap

Full Usage: SourceMap

Field type: bool voption
Field type: bool voption

SourceRoot

Full Usage: SourceRoot

Field type: string voption
Field type: string voption

StableTypeOrdering

Full Usage: StableTypeOrdering

Field type: bool voption
Field type: bool voption

Strict

Full Usage: Strict

Field type: bool voption
Field type: bool voption

StrictBindCallApply

Full Usage: StrictBindCallApply

Field type: bool voption
Field type: bool voption

StrictBuiltinIteratorReturn

Full Usage: StrictBuiltinIteratorReturn

Field type: bool voption
Field type: bool voption

StrictFunctionTypes

Full Usage: StrictFunctionTypes

Field type: bool voption
Field type: bool voption

StrictNullChecks

Full Usage: StrictNullChecks

Field type: bool voption
Field type: bool voption

StrictPropertyInitialization

Full Usage: StrictPropertyInitialization

Field type: bool voption
Field type: bool voption

StripInternal

Full Usage: StripInternal

Field type: bool voption
Field type: bool voption

SuppressOutputPathCheck

Full Usage: SuppressOutputPathCheck

Field type: bool voption
Field type: bool voption

Target

Full Usage: Target

Field type: ScriptTarget voption
Field type: ScriptTarget voption

TraceResolution

Full Usage: TraceResolution

Field type: bool voption
Field type: bool voption

TsBuildInfoFile

Full Usage: TsBuildInfoFile

Field type: string voption
Field type: string voption

TypeRoots

Full Usage: TypeRoots

Field type: string[] voption
Field type: string[] voption

Types

Full Usage: Types

Field type: string[] voption
Field type: string[] voption

UseDefineForClassFields

Full Usage: UseDefineForClassFields

Field type: bool voption
Field type: bool voption

UseUnknownInCatchVariables

Full Usage: UseUnknownInCatchVariables

Field type: bool voption
Field type: bool voption

VerbatimModuleSyntax

Full Usage: VerbatimModuleSyntax

Field type: bool voption
Field type: bool voption

Static members

Static member Description

CompilerOptions.Default

Full Usage: CompilerOptions.Default

Returns: CompilerOptions

The record with nothing set: every field is either optional or a default of its own, so this serialises to `{}`. Copy-update it to fill in the fields you mean - `{ CompilerOptions.Default with ... }` - rather than writing all 101 out.

Returns: CompilerOptions

Type something to start searching.