Type Alias CompilerOptions

CompilerOptions: {
    allowArbitraryExtensions?: boolean;
    allowImportingTsExtensions?: boolean;
    allowJs?: boolean;
    allowSyntheticDefaultImports?: boolean;
    allowUmdGlobalAccess?: boolean;
    allowUnreachableCode?: boolean;
    allowUnusedLabels?: boolean;
    alwaysStrict?: boolean;
    assumeChangesOnlyAffectDirectDependencies?: boolean;
    baseUrl?: string;
    charset?: string;
    checkJs?: boolean;
    composite?: boolean;
    customConditions?: string[];
    declaration?: boolean;
    declarationDir?: string;
    declarationMap?: boolean;
    diagnostics?: boolean;
    disableReferencedProjectLoad?: boolean;
    disableSizeLimit?: boolean;
    disableSolutionSearching?: boolean;
    disableSourceOfProjectReferenceRedirect?: boolean;
    downlevelIteration?: boolean;
    emitBOM?: boolean;
    emitDeclarationOnly?: boolean;
    emitDecoratorMetadata?: boolean;
    esModuleInterop?: boolean;
    exactOptionalPropertyTypes?: boolean;
    experimentalDecorators?: boolean;
    explainFiles?: boolean;
    extendedDiagnostics?: boolean;
    fallbackPolling?: FallbackPolling;
    forceConsistentCasingInFileNames?: boolean;
    generateCpuProfile?: string;
    ignoreDeprecations?: IgnoreDeprecations;
    importHelpers?: boolean;
    importsNotUsedAsValues?: ImportsNotUsedAsValues;
    incremental?: boolean;
    inlineSourceMap?: boolean;
    inlineSources?: boolean;
    isolatedModules?: boolean;
    jsx?: JSX;
    jsxFactory?: string;
    jsxFragmentFactory?: string;
    jsxImportSource?: string;
    keyofStringsOnly?: boolean;
    lib?: Lib[];
    listEmittedFiles?: boolean;
    listFiles?: boolean;
    listFilesOnly?: boolean;
    mapRoot?: string;
    maxNodeModuleJsDepth?: number;
    module?: Module;
    moduleDetection?: ModuleDetection;
    moduleResolution?: ModuleResolution;
    moduleSuffixes?: string[];
    newLine?: NewLine;
    noEmit?: boolean;
    noEmitHelpers?: boolean;
    noEmitOnError?: boolean;
    noErrorTruncation?: boolean;
    noFallthroughCasesInSwitch?: boolean;
    noImplicitAny?: boolean;
    noImplicitOverride?: boolean;
    noImplicitReturns?: boolean;
    noImplicitThis?: boolean;
    noImplicitUseStrict?: boolean;
    noLib?: boolean;
    noPropertyAccessFromIndexSignature?: boolean;
    noResolve?: boolean;
    noStrictGenericChecks?: boolean;
    noUncheckedIndexedAccess?: boolean;
    noUnusedLocals?: boolean;
    noUnusedParameters?: boolean;
    outDir?: string;
    outFile?: string;
    paths?: Record<string, string[]>;
    plugins?: Plugin[];
    preserveConstEnums?: boolean;
    preserveSymlinks?: boolean;
    preserveValueImports?: boolean;
    preserveWatchOutput?: boolean;
    pretty?: boolean;
    reactNamespace?: string;
    removeComments?: boolean;
    resolveJsonModule?: boolean;
    resolvePackageJsonExports?: boolean;
    resolvePackageJsonImports?: boolean;
    rootDir?: string;
    rootDirs?: string[];
    skipDefaultLibCheck?: boolean;
    skipLibCheck?: boolean;
    sourceMap?: boolean;
    sourceRoot?: string;
    strict?: boolean;
    strictBindCallApply?: boolean;
    strictFunctionTypes?: boolean;
    strictNullChecks?: boolean;
    strictPropertyInitialization?: boolean;
    stripInternal?: boolean;
    suppressExcessPropertyErrors?: boolean;
    suppressImplicitAnyIndexErrors?: boolean;
    target?: Target;
    traceResolution?: boolean;
    tsBuildInfoFile?: string;
    typeRoots?: string[];
    types?: string[];
    useDefineForClassFields?: boolean;
    useUnknownInCatchVariables?: boolean;
    verbatimModuleSyntax?: boolean;
    watch?: boolean;
    watchDirectory?: WatchDirectory;
    watchFile?: WatchFile;
}

Type declaration

OptionalallowArbitraryExtensions?: boolean
Suppress errors for file formats that TypeScript does not understand.
Default
```
false
```
OptionalallowImportingTsExtensions?: boolean
Allows TypeScript files to import each other with a TypeScript-specific extension like .ts, .mts, or .tsx.
Default
```
false
```
OptionalallowJs?: boolean
Allow javascript files to be compiled.
Default
```
false
```
OptionalallowSyntheticDefaultImports?: boolean
Allow default imports from modules with no default export. This does not affect code emit, just typechecking.
Default
```
module === 'system' || esModuleInterop
```
OptionalallowUmdGlobalAccess?: boolean
Allow accessing UMD globals from modules.
Default
```
false
```
OptionalallowUnreachableCode?: boolean
Do not report errors on unreachable code.
Default
```
false
```
OptionalallowUnusedLabels?: boolean
Do not report errors on unused labels.
Default
```
false
```
OptionalalwaysStrict?: boolean
Parse in strict mode and emit 'use strict' for each source file.
Default
```
false
```
OptionalassumeChangesOnlyAffectDirectDependencies?: boolean
Have recompiles in '--incremental' and '--watch' assume that changes within a file will only affect files directly depending on it.
Default
```
false
```
OptionalbaseUrl?: string
Base directory to resolve non-relative module names.
Optionalcharset?: string
The character set of the input files.
Default
```
'utf8'
```
Deprecated
This option will be removed in TypeScript 5.5.
OptionalcheckJs?: boolean
Report errors in .js files.
Default
```
false
```
Optionalcomposite?: boolean
Enables building for project references.
Default
```
true
```
OptionalcustomConditions?: string[]
List of additional conditions that should succeed when TypeScript resolves from package.json.
Optionaldeclaration?: boolean
Generates corresponding d.ts files.
Default
```
false
```
OptionaldeclarationDir?: string
Specify output directory for generated declaration files.
OptionaldeclarationMap?: boolean
Generates a sourcemap for each corresponding .d.ts file.
Default
```
false
```
Optionaldiagnostics?: boolean
Show diagnostic information.
Default
```
false
```
OptionaldisableReferencedProjectLoad?: boolean
Reduce the number of projects loaded automatically by TypeScript.
Default
```
false
```
OptionaldisableSizeLimit?: boolean
Disable size limit for JavaScript project.
Default
```
false
```
OptionaldisableSolutionSearching?: boolean
Opt a project out of multi-project reference checking when editing.
Default
```
false
```
OptionaldisableSourceOfProjectReferenceRedirect?: boolean
Disable preferring source files instead of declaration files when referencing composite projects.
Default
```
true if composite, false otherwise
```
OptionaldownlevelIteration?: boolean
Provide full support for iterables in for-of, spread, and destructuring when targeting ES5 or ES3.
Default
```
false
```
OptionalemitBOM?: boolean
Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files.
Default
```
false
```
OptionalemitDeclarationOnly?: boolean
Only emit .d.ts declaration files.
Default
```
false
```
OptionalemitDecoratorMetadata?: boolean
Emit design-type metadata for decorated declarations in source.
Default
```
false
```
OptionalesModuleInterop?: boolean
Emit __importStar and __importDefault helpers for runtime Babel ecosystem compatibility and enable --allowSyntheticDefaultImports for typesystem compatibility.
Default
```
false
```
OptionalexactOptionalPropertyTypes?: boolean
Differentiate between undefined and not present when type checking.
Default
```
false
```
OptionalexperimentalDecorators?: boolean
Enables experimental support for ES7 decorators.
Default
```
false
```
OptionalexplainFiles?: boolean
Print names of files which TypeScript sees as a part of your project and the reason they are part of the compilation.
Default
```
false
```
OptionalextendedDiagnostics?: boolean
Output more detailed compiler performance information after building.
Default
```
false
```
OptionalfallbackPolling?: FallbackPolling
Specify the polling strategy to use when the system runs out of or doesn't support native file watchers.

Deprecated
Use watchOptions.fallbackPolling instead.
OptionalforceConsistentCasingInFileNames?: boolean
Disallow inconsistently-cased references to the same file.
Default
```
true
```
OptionalgenerateCpuProfile?: string
Emit a v8 CPU profile of the compiler run for debugging.
Default
```
'profile.cpuprofile'
```
OptionalignoreDeprecations?: IgnoreDeprecations
Suppress deprecation warnings
OptionalimportHelpers?: boolean
Import emit helpers (e.g. __extends, __rest, etc..) from tslib.
Default
```
false
```
OptionalimportsNotUsedAsValues?: ImportsNotUsedAsValues
Specify emit/checking behavior for imports that are only used for types.
Default
```
'remove'
```
Deprecated
Use verbatimModuleSyntax instead.
Optionalincremental?: boolean
Enable incremental compilation.

Default
composite
OptionalinlineSourceMap?: boolean
Emit a single file with source maps instead of having a separate file.
Default
```
false
```
OptionalinlineSources?: boolean
Emit the source alongside the sourcemaps within a single file.

Requires --inlineSourceMap to be set.
Default
```
false
```
OptionalisolatedModules?: boolean
Unconditionally emit imports for unresolved files.
Default
```
false
```
Optionaljsx?: JSX
Specify what JSX code is generated.
Default
```
'preserve'
```
OptionaljsxFactory?: string
Specify the JSX factory function to use when targeting React JSX emit, e.g. React.createElement or h.
Default
```
'React.createElement'
```
OptionaljsxFragmentFactory?: string
Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'.
Default
```
'React.Fragment'
```
OptionaljsxImportSource?: string
Specify module specifier used to import the JSX factory functions when using jsx: react-jsx*.
Default
```
'react'
```
OptionalkeyofStringsOnly?: boolean
Resolve keyof to string valued property names only (no numbers or symbols).
Default
```
false
```
Deprecated
This option will be removed in TypeScript 5.5.
Optionallib?: Lib[]
List of library files to be included in the compilation.
OptionallistEmittedFiles?: boolean
Enable to list all emitted files.
Default
```
false
```
OptionallistFiles?: boolean
Print names of files part of the compilation.
Default
```
false
```
OptionallistFilesOnly?: boolean
Print names of files that are part of the compilation and then stop processing.
Default
```
false
```
OptionalmapRoot?: string
Specifies the location where debugger should locate map files instead of generated locations.
OptionalmaxNodeModuleJsDepth?: number
The maximum dependency depth to search under node_modules and load JavaScript files. Only applicable with --allowJs.
Default
```
0
```
Optionalmodule?: Module
Specify module code generation: 'None', 'CommonJS', 'AMD', 'System', 'UMD', 'ES6', 'ES2015' or 'ESNext'. Only 'AMD' and 'System' can be used in conjunction with --outFile. 'ES6' and 'ES2015' values may be used when targeting 'ES5' or lower.
Default
```
['ES3', 'ES5'].includes(target) ? 'CommonJS' : 'ES6'
```
OptionalmoduleDetection?: ModuleDetection
Control what method is used to detect module-format JS files.
Default
```
'auto'
```
OptionalmoduleResolution?: ModuleResolution
Specifies module resolution strategy: 'node' (Node) or 'classic' (TypeScript pre 1.6).
Default
```
['AMD', 'System', 'ES6'].includes(module) ? 'classic' : 'node'
```
OptionalmoduleSuffixes?: string[]
List of file name suffixes to search when resolving a module.
OptionalnewLine?: NewLine
Specifies the end of line sequence to be used when emitting files: 'crlf' (Windows) or 'lf' (Unix).
Default
```
'LF'
```
OptionalnoEmit?: boolean
Do not emit output.
Default
```
false
```
OptionalnoEmitHelpers?: boolean
Do not generate custom helper functions like __extends in compiled output.
Default
```
false
```
OptionalnoEmitOnError?: boolean
Do not emit outputs if any type checking errors were reported.
Default
```
false
```
OptionalnoErrorTruncation?: boolean
Do not truncate error messages.
Default
```
false
```
OptionalnoFallthroughCasesInSwitch?: boolean
Report errors for fallthrough cases in switch statement.
Default
```
false
```
OptionalnoImplicitAny?: boolean
Warn on expressions and declarations with an implied 'any' type.
Default
```
false
```
OptionalnoImplicitOverride?: boolean
Ensure overriding members in derived classes are marked with an override modifier.
Default
```
false
```
OptionalnoImplicitReturns?: boolean
Report error when not all code paths in function return a value.
Default
```
false
```
OptionalnoImplicitThis?: boolean
Raise error on 'this' expressions with an implied any type.
Default
```
false
```
OptionalnoImplicitUseStrict?: boolean
Do not emit 'use strict' directives in module output.
Default
```
false
```
Deprecated
This option will be removed in TypeScript 5.5.
OptionalnoLib?: boolean
Do not include the default library file (lib.d.ts).
Default
```
false
```
OptionalnoPropertyAccessFromIndexSignature?: boolean
Enforces using indexed accessors for keys declared using an indexed type.
Default
```
false
```
OptionalnoResolve?: boolean
Do not add triple-slash references or module import targets to the list of compiled files.
Default
```
false
```
OptionalnoStrictGenericChecks?: boolean
Disable strict checking of generic signatures in function types.
Default
```
false
```
Deprecated
This option will be removed in TypeScript 5.5.
OptionalnoUncheckedIndexedAccess?: boolean
Add undefined to a type when accessed using an index.
Default
```
false
```
OptionalnoUnusedLocals?: boolean
Report errors on unused locals.
Default
```
false
```
OptionalnoUnusedParameters?: boolean
Report errors on unused parameters.
Default
```
false
```
OptionaloutDir?: string
Redirect output structure to the directory.
OptionaloutFile?: string
Concatenate and emit output to single file.
Optionalpaths?: Record<string, string[]>
Specify path mapping to be computed relative to baseUrl option.
Optionalplugins?: Plugin[]
List of TypeScript language server plugins to load.
OptionalpreserveConstEnums?: boolean
Do not erase const enum declarations in generated code.
Default
```
false
```
OptionalpreserveSymlinks?: boolean
Do not resolve symlinks to their real path; treat a symlinked file like a real one.
Default
```
false
```
OptionalpreserveValueImports?: boolean
Preserve unused imported values in the JavaScript output that would otherwise be removed.
Default
```
true
```
Deprecated
Use verbatimModuleSyntax instead.
OptionalpreserveWatchOutput?: boolean
Keep outdated console output in watch mode instead of clearing the screen.
Default
```
false
```
Optionalpretty?: boolean
Stylize errors and messages using color and context (experimental).
Default
```
true // Unless piping to another program or redirecting output to a file.
```
OptionalreactNamespace?: string
Specifies the object invoked for createElement and __spread when targeting 'react' JSX emit.
Default
```
'React'
```
OptionalremoveComments?: boolean
Do not emit comments to output.
Default
```
false
```
OptionalresolveJsonModule?: boolean
Include modules imported with .json extension.
Default
```
false
```
OptionalresolvePackageJsonExports?: boolean
Forces TypeScript to consult the exports field of package.json files if it ever reads from a package in node_modules.
Default
```
false
```
OptionalresolvePackageJsonImports?: boolean
Forces TypeScript to consult the imports field of package.json files when performing a lookup that starts with # from a file whose ancestor directory contains a package.json.
Default
```
false
```
OptionalrootDir?: string
Specifies the root directory of input files.

Use to control the output directory structure with --outDir.
OptionalrootDirs?: string[]
Specify list of root directories to be used when resolving modules.
OptionalskipDefaultLibCheck?: boolean
Deprecated
use skipLibCheck instead.
OptionalskipLibCheck?: boolean
Skip type checking of declaration files.
Default
```
false
```
OptionalsourceMap?: boolean
Generates corresponding '.map' file.
Default
```
false
```
OptionalsourceRoot?: string
Specifies the location where debugger should locate TypeScript files instead of source locations.
Optionalstrict?: boolean
Enable all strict type checking options.
Default
```
false
```
OptionalstrictBindCallApply?: boolean
Enable stricter checking of of the bind, call, and apply methods on functions.
Default
```
false
```
OptionalstrictFunctionTypes?: boolean
Disable bivariant parameter checking for function types.
Default
```
false
```
OptionalstrictNullChecks?: boolean
Enable strict null checks.
Default
```
false
```
OptionalstrictPropertyInitialization?: boolean
Ensure non-undefined class properties are initialized in the constructor.
Default
```
false
```
OptionalstripInternal?: boolean
Do not emit declarations for code that has an @internal annotation.
OptionalsuppressExcessPropertyErrors?: boolean
Suppress excess property checks for object literals.
Default
```
false
```
Deprecated
This option will be removed in TypeScript 5.5.
OptionalsuppressImplicitAnyIndexErrors?: boolean
Suppress noImplicitAny errors for indexing objects lacking index signatures.
Default
```
false
```
Deprecated
This option will be removed in TypeScript 5.5.
Optionaltarget?: Target
Specify ECMAScript target version.
Default
```
'es3'
```
OptionaltraceResolution?: boolean
Enable tracing of the name resolution process.
Default
```
false
```
OptionaltsBuildInfoFile?: string
Specify file to store incremental compilation information.
Default
```
'.tsbuildinfo'
```
OptionaltypeRoots?: string[]
Specify list of directories for type definition files to be included.
Optionaltypes?: string[]
Type declaration files to be included in compilation.
OptionaluseDefineForClassFields?: boolean
Emit ECMAScript standard class fields.
Default
```
false
```
OptionaluseUnknownInCatchVariables?: boolean
Default catch clause variables as unknown instead of any.
Default
```
false
```
OptionalverbatimModuleSyntax?: boolean
Anything that uses the type modifier is dropped entirely.
Default
```
false
```
Optionalwatch?: boolean
Watch input files.
Default
```
false
```
Deprecated
Use watchOptions instead.
OptionalwatchDirectory?: WatchDirectory
Specify the strategy for watching directories under systems that lack recursive file-watching functionality.
Default
```
'useFsEvents'
```
Deprecated
Use watchOptions.watchDirectory instead.
OptionalwatchFile?: WatchFile
Specify the strategy for watching individual files.
Default
```
'useFsEvents'
```
Deprecated
Use watchOptions.watchFile instead.

Type Alias CompilerOptions

Type declaration

OptionalallowArbitraryExtensions?: boolean

Default

OptionalallowImportingTsExtensions?: boolean

Default

OptionalallowJs?: boolean

Default

OptionalallowSyntheticDefaultImports?: boolean

Default

OptionalallowUmdGlobalAccess?: boolean

Default

OptionalallowUnreachableCode?: boolean

Default

OptionalallowUnusedLabels?: boolean

Default

OptionalalwaysStrict?: boolean

Default

OptionalassumeChangesOnlyAffectDirectDependencies?: boolean

Default

OptionalbaseUrl?: string

Optionalcharset?: string

Default

Deprecated

OptionalcheckJs?: boolean

Default

Optionalcomposite?: boolean

Default

OptionalcustomConditions?: string[]

Optionaldeclaration?: boolean

Default

OptionaldeclarationDir?: string

OptionaldeclarationMap?: boolean

Default

Optionaldiagnostics?: boolean

Default

OptionaldisableReferencedProjectLoad?: boolean

Default

OptionaldisableSizeLimit?: boolean

Default

OptionaldisableSolutionSearching?: boolean

Default

OptionaldisableSourceOfProjectReferenceRedirect?: boolean

Default

OptionaldownlevelIteration?: boolean

Default

OptionalemitBOM?: boolean

Default

OptionalemitDeclarationOnly?: boolean

Default

OptionalemitDecoratorMetadata?: boolean

Default

OptionalesModuleInterop?: boolean

Default

OptionalexactOptionalPropertyTypes?: boolean

Default

OptionalexperimentalDecorators?: boolean

Default

OptionalexplainFiles?: boolean

Default

OptionalextendedDiagnostics?: boolean

Default

OptionalfallbackPolling?: FallbackPolling

Deprecated

OptionalforceConsistentCasingInFileNames?: boolean

Default

OptionalgenerateCpuProfile?: string

Default

OptionalignoreDeprecations?: IgnoreDeprecations

OptionalimportHelpers?: boolean

Default

OptionalimportsNotUsedAsValues?: ImportsNotUsedAsValues

Default

Deprecated

Optionalincremental?: boolean

Default

OptionalinlineSourceMap?: boolean

Default

OptionalinlineSources?: boolean

Default

`Optional`allowArbitraryExtensions?: boolean

`Optional`allowImportingTsExtensions?: boolean

`Optional`allowJs?: boolean

`Optional`allowSyntheticDefaultImports?: boolean

`Optional`allowUmdGlobalAccess?: boolean

`Optional`allowUnreachableCode?: boolean

`Optional`allowUnusedLabels?: boolean

`Optional`alwaysStrict?: boolean

`Optional`assumeChangesOnlyAffectDirectDependencies?: boolean

`Optional`baseUrl?: string

`Optional`charset?: string

`Optional`checkJs?: boolean

`Optional`composite?: boolean

`Optional`customConditions?: string[]

`Optional`declaration?: boolean

`Optional`declarationDir?: string

`Optional`declarationMap?: boolean

`Optional`diagnostics?: boolean

`Optional`disableReferencedProjectLoad?: boolean

`Optional`disableSizeLimit?: boolean

`Optional`disableSolutionSearching?: boolean

`Optional`disableSourceOfProjectReferenceRedirect?: boolean

`Optional`downlevelIteration?: boolean

`Optional`emitBOM?: boolean

`Optional`emitDeclarationOnly?: boolean

`Optional`emitDecoratorMetadata?: boolean

`Optional`esModuleInterop?: boolean

`Optional`exactOptionalPropertyTypes?: boolean

`Optional`experimentalDecorators?: boolean

`Optional`explainFiles?: boolean

`Optional`extendedDiagnostics?: boolean

`Optional`fallbackPolling?: FallbackPolling

`Optional`forceConsistentCasingInFileNames?: boolean

`Optional`generateCpuProfile?: string

`Optional`ignoreDeprecations?: IgnoreDeprecations

`Optional`importHelpers?: boolean

`Optional`importsNotUsedAsValues?: ImportsNotUsedAsValues

`Optional`incremental?: boolean

`Optional`inlineSourceMap?: boolean

`Optional`inlineSources?: boolean

`Optional`isolatedModules?: boolean

`Optional`jsx?: JSX

`Optional`jsxFactory?: string

`Optional`jsxFragmentFactory?: string

`Optional`jsxImportSource?: string

`Optional`keyofStringsOnly?: boolean

`Optional`lib?: Lib[]

`Optional`listEmittedFiles?: boolean

`Optional`listFiles?: boolean

`Optional`listFilesOnly?: boolean

`Optional`mapRoot?: string

`Optional`maxNodeModuleJsDepth?: number

`Optional`module?: Module

`Optional`moduleDetection?: ModuleDetection

`Optional`moduleResolution?: ModuleResolution

`Optional`moduleSuffixes?: string[]

`Optional`newLine?: NewLine

`Optional`noEmit?: boolean

`Optional`noEmitHelpers?: boolean

`Optional`noEmitOnError?: boolean

`Optional`noErrorTruncation?: boolean

`Optional`noFallthroughCasesInSwitch?: boolean

`Optional`noImplicitAny?: boolean

`Optional`noImplicitOverride?: boolean

`Optional`noImplicitReturns?: boolean

`Optional`noImplicitThis?: boolean

`Optional`noImplicitUseStrict?: boolean

`Optional`noLib?: boolean

`Optional`noPropertyAccessFromIndexSignature?: boolean

`Optional`noResolve?: boolean

`Optional`noStrictGenericChecks?: boolean

`Optional`noUncheckedIndexedAccess?: boolean

`Optional`noUnusedLocals?: boolean

`Optional`noUnusedParameters?: boolean

`Optional`outDir?: string

`Optional`outFile?: string