OptionalallowOptionalallowAllows TypeScript files to import each other with a TypeScript-specific extension like .ts, .mts, or .tsx.
OptionalallowAllow javascript files to be compiled.
OptionalallowAllow default imports from modules with no default export. This does not affect code emit, just typechecking.
OptionalallowAllow accessing UMD globals from modules.
OptionalallowDo not report errors on unreachable code.
OptionalallowDo not report errors on unused labels.
OptionalalwaysParse in strict mode and emit 'use strict' for each source file.
OptionalassumeHave recompiles in '--incremental' and '--watch' assume that changes within a file will only affect files directly depending on it.
OptionalbaseBase directory to resolve non-relative module names.
OptionalcharsetThe character set of the input files.
OptionalcheckReport errors in .js files.
OptionalcompositeEnables building for project references.
OptionalcustomList of additional conditions that should succeed when TypeScript resolves from package.json.
OptionaldeclarationGenerates corresponding d.ts files.
OptionaldeclarationSpecify output directory for generated declaration files.
OptionaldeclarationGenerates a sourcemap for each corresponding .d.ts file.
OptionaldiagnosticsShow diagnostic information.
OptionaldisableReduce the number of projects loaded automatically by TypeScript.
OptionaldisableDisable size limit for JavaScript project.
OptionaldisableOpt a project out of multi-project reference checking when editing.
OptionaldisableDisable preferring source files instead of declaration files when referencing composite projects.
OptionaldownlevelProvide full support for iterables in for-of, spread, and destructuring when targeting ES5 or ES3.
OptionalemitEmit a UTF-8 Byte Order Mark (BOM) in the beginning of output files.
OptionalemitOnly emit .d.ts declaration files.
OptionalemitEmit design-type metadata for decorated declarations in source.
OptionalerasableDo not allow runtime constructs that are not part of ECMAScript.
OptionalesEmit __importStar and __importDefault helpers for runtime Babel ecosystem compatibility and enable --allowSyntheticDefaultImports for typesystem compatibility.
OptionalexactDifferentiate between undefined and not present when type checking.
OptionalexperimentalEnables experimental support for ES7 decorators.
OptionalexplainPrint names of files which TypeScript sees as a part of your project and the reason they are part of the compilation.
OptionalextendedOutput more detailed compiler performance information after building.
OptionalfallbackSpecify the polling strategy to use when the system runs out of or doesn't support native file watchers.
OptionalforceDisallow inconsistently-cased references to the same file.
OptionalgenerateEmit a v8 CPU profile of the compiler run for debugging.
OptionalgenerateGenerates an event trace and a list of types.
OptionalignoreSuppress deprecation warnings
OptionalimportImport emit helpers (e.g. __extends, __rest, etc..) from tslib.
OptionalimportsSpecify emit/checking behavior for imports that are only used for types.
OptionalincrementalEnable incremental compilation.
OptionalinlineEmit a single file with source maps instead of having a separate file.
OptionalinlineEmit the source alongside the sourcemaps within a single file.
Requires --inlineSourceMap to be set.
OptionalisolatedRequire sufficient annotation on exports so other tools can trivially generate declaration files.
OptionalisolatedUnconditionally emit imports for unresolved files.
OptionaljsxSpecify what JSX code is generated.
OptionaljsxSpecify the JSX factory function to use when targeting React JSX emit, e.g. React.createElement or h.
OptionaljsxSpecify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'.
OptionaljsxSpecify module specifier used to import the JSX factory functions when using jsx: react-jsx*.
OptionalkeyofResolve keyof to string valued property names only (no numbers or symbols).
OptionallibList of library files to be included in the compilation.
OptionallibEnable lib replacement.
OptionallistEnable to list all emitted files.
OptionallistPrint names of files part of the compilation.
OptionallistPrint names of files that are part of the compilation and then stop processing.
OptionalmapSpecifies the location where debugger should locate map files instead of generated locations.
OptionalmaxThe maximum dependency depth to search under node_modules and load JavaScript files. Only applicable with --allowJs.
OptionalmoduleSpecify 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.
OptionalmoduleControl what method is used to detect module-format JS files.
OptionalmoduleSpecifies module resolution strategy: 'node' (Node) or 'classic' (TypeScript pre 1.6).
OptionalmoduleList of file name suffixes to search when resolving a module.
OptionalnewSpecifies the end of line sequence to be used when emitting files: 'crlf' (Windows) or 'lf' (Unix).
OptionalnoDisable full type checking (only critical parse and emit errors will be reported).
OptionalnoDo not emit output.
OptionalnoDo not generate custom helper functions like __extends in compiled output.
OptionalnoDo not emit outputs if any type checking errors were reported.
OptionalnoDo not truncate error messages.
OptionalnoReport errors for fallthrough cases in switch statement.
OptionalnoWarn on expressions and declarations with an implied 'any' type.
OptionalnoEnsure overriding members in derived classes are marked with an override modifier.
OptionalnoReport error when not all code paths in function return a value.
OptionalnoRaise error on 'this' expressions with an implied any type.
OptionalnoDo not emit 'use strict' directives in module output.
OptionalnoDo not include the default library file (lib.d.ts).
OptionalnoEnforces using indexed accessors for keys declared using an indexed type.
OptionalnoDo not add triple-slash references or module import targets to the list of compiled files.
OptionalnoDisable strict checking of generic signatures in function types.
OptionalnoAdd undefined to a type when accessed using an index.
OptionalnoReport error if failed to find a source file for a side effect import.
OptionalnoReport errors on unused locals.
OptionalnoReport errors on unused parameters.
OptionaloutRedirect output structure to the directory.
OptionaloutConcatenate and emit output to single file.
OptionalpathsSpecify path mapping to be computed relative to baseUrl option.
OptionalpluginsList of TypeScript language server plugins to load.
OptionalpreserveDo not erase const enum declarations in generated code.
OptionalpreserveDo not resolve symlinks to their real path; treat a symlinked file like a real one.
OptionalpreservePreserve unused imported values in the JavaScript output that would otherwise be removed.
OptionalpreserveKeep outdated console output in watch mode instead of clearing the screen.
OptionalprettyStylize errors and messages using color and context (experimental).
OptionalreactSpecifies the object invoked for createElement and __spread when targeting 'react' JSX emit.
OptionalremoveDo not emit comments to output.
OptionalresolveInclude modules imported with .json extension.
OptionalresolveForces TypeScript to consult the exports field of package.json files if it ever reads from a package in node_modules.
OptionalresolveForces 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.
OptionalrewriteRewrite '.ts', '.tsx', '.mts', and '.cts' file extensions in relative import paths to their JavaScript equivalent in output files.
OptionalrootSpecifies the root directory of input files.
Use to control the output directory structure with --outDir.
OptionalrootSpecify list of root directories to be used when resolving modules.
OptionalskipOptionalskipSkip type checking of declaration files.
OptionalsourceGenerates corresponding '.map' file.
OptionalsourceSpecifies the location where debugger should locate TypeScript files instead of source locations.
OptionalstrictEnable all strict type checking options.
OptionalstrictEnable stricter checking of of the bind, call, and apply methods on functions.
OptionalstrictBuilt-in iterators are instantiated with a TReturn type of undefined instead of any.
OptionalstrictDisable bivariant parameter checking for function types.
OptionalstrictEnable strict null checks.
OptionalstrictEnsure non-undefined class properties are initialized in the constructor.
OptionalstripDo not emit declarations for code that has an @internal annotation.
OptionalsuppressSuppress excess property checks for object literals.
OptionalsuppressSuppress noImplicitAny errors for indexing objects lacking index signatures.
OptionaltargetSpecify ECMAScript target version.
OptionaltraceEnable tracing of the name resolution process.
OptionaltsSpecify file to store incremental compilation information.
OptionaltypeSpecify list of directories for type definition files to be included.
OptionaltypesType declaration files to be included in compilation.
OptionaluseEmit ECMAScript standard class fields.
OptionaluseDefault catch clause variables as unknown instead of any.
OptionalverbatimAnything that uses the type modifier is dropped entirely.
OptionalwatchWatch input files.
OptionalwatchSpecify the strategy for watching directories under systems that lack recursive file-watching functionality.
OptionalwatchSpecify the strategy for watching individual files.
Suppress errors for file formats that TypeScript does not understand.