Type Alias CompilerOptions

Type Declaration

• OptionalallowArbitraryExtensions?: boolean | null

  Enable importing files with any extension, provided a declaration file is present.

• OptionalallowImportingTsExtensions?: boolean | null

  Allow imports to include TypeScript file extensions. Requires --moduleResolution bundler and either --noEmit or --emitDeclarationOnly to be set.

• OptionalallowJs?: boolean | null

  Allow JavaScript files to be a part of your program. Use the checkJs option to get errors from these files.

• OptionalallowSyntheticDefaultImports?: boolean | null

  Allow import x from y when a module doesn't have a default export.

• OptionalallowUmdGlobalAccess?: boolean | null

  Allow accessing UMD globals from modules.

• OptionalallowUnreachableCode?: boolean | null

  Disable error reporting for unreachable code.

• OptionalallowUnusedLabels?: boolean | null

  Disable error reporting for unused labels.

• OptionalalwaysStrict?: boolean | null

  Ensure use strict is always emitted.

• OptionalassumeChangesOnlyAffectDirectDependencies?: boolean | null

  Have recompiles in projects that use incremental and watch mode assume that changes within a file will only affect files directly depending on it.

• OptionalbaseUrl?: string | null

  Specify the base directory to resolve non-relative module names.

• Optionalcharset?: string | null

  No longer supported. In early versions, manually set the text encoding for reading files.

• OptionalcheckJs?: boolean | null

  Enable error reporting in type-checked JavaScript files.

• Optionalcomposite?: boolean | null

  Enable constraints that allow a TypeScript project to be used with project references.

• OptionalcustomConditions?: string[] | null

  Conditions to set in addition to the resolver-specific defaults when resolving imports.

• Optionaldeclaration?: boolean | null

  Generate .d.ts files from TypeScript and JavaScript files in your project.

• OptionaldeclarationDir?: string | null

  Specify the output directory for generated declaration files.

• OptionaldeclarationMap?: boolean | null

  Create sourcemaps for d.ts files.

• Optionaldiagnostics?: boolean | null

  Output compiler performance information after building.

• OptionaldisableReferencedProjectLoad?: boolean | null

  Reduce the number of projects loaded automatically by TypeScript.

• OptionaldisableSizeLimit?: boolean | null

  Remove the 20mb cap on total source code size for JavaScript files in the TypeScript language server.

• OptionaldisableSolutionSearching?: boolean | null

  Opt a project out of multi-project reference checking when editing.

• OptionaldisableSourceOfProjectReferenceRedirect?: boolean | null

  Disable preferring source files instead of declaration files when referencing composite projects.

• OptionaldownlevelIteration?: boolean | null

  Emit more compliant, but verbose and less performant JavaScript for iteration.

• OptionalemitBOM?: boolean | null

  Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files.

• OptionalemitDeclarationOnly?: boolean | null

  Only output d.ts files and not JavaScript files.

• OptionalemitDecoratorMetadata?: boolean | null

  Emit design-type metadata for decorated declarations in source files.

• OptionalerasableSyntaxOnly?: boolean | null

  Do not allow runtime constructs that are not part of ECMAScript.

• OptionalesModuleInterop?: boolean | null

  Emit additional JavaScript to ease support for importing CommonJS modules. This enables allowSyntheticDefaultImports for type compatibility.

• OptionalexactOptionalPropertyTypes?: boolean | null

  Interpret optional property types as written, rather than adding undefined.

• OptionalexperimentalDecorators?: boolean | null

  Enable experimental support for legacy experimental decorators.

• OptionalextendedDiagnostics?: boolean | null

  Output more detailed compiler performance information after building.

• OptionalfallbackPolling?:
      | "fixedPollingInterval"
      | "priorityPollingInterval"
      | "dynamicPriorityPolling"
      | "fixedInterval"
      | "priorityInterval"
      | "dynamicPriority"
      | "fixedChunkSize"

  Specify the polling strategy to use when the system runs out of or doesn't support native file watchers. Requires TypeScript version 3.8 or later.

• OptionalforceConsistentCasingInFileNames?: boolean | null

  Ensure that casing is correct in imports.

• OptionalgenerateCpuProfile?: string | null

  Emit a v8 CPU profile of the compiler run for debugging.

• OptionalimportHelpers?: boolean | null

  Allow importing helper functions from tslib once per project, instead of including them per-file.

• OptionalimportsNotUsedAsValues?: "remove" | "preserve" | "error"

  Specify emit/checking behavior for imports that are only used for types.

• Optionalincremental?: boolean | null

  Enable incremental compilation. Requires TypeScript version 3.4 or later.

• OptionalinlineSourceMap?: boolean | null

  Include sourcemap files inside the emitted JavaScript.

• OptionalinlineSources?: boolean | null

  Include source code in the sourcemaps inside the emitted JavaScript.

• OptionalisolatedDeclarations?: boolean | null

  Require sufficient annotation on exports so other tools can trivially generate declaration files.

• OptionalisolatedModules?: boolean | null

  Ensure that each file can be safely transpiled without relying on other imports.

• Optionaljsx?: "preserve" | "react" | "react-jsx" | "react-jsxdev" | "react-native"

  Specify what JSX code is generated.

• OptionaljsxFactory?: string | null

  Specify the JSX factory function used when targeting React JSX emit, e.g. React.createElement or h.

• OptionaljsxFragmentFactory?: string | null

  Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. React.Fragment or Fragment.

• OptionaljsxImportSource?: string | null

  Specify module specifier used to import the JSX factory functions when using jsx: react-jsx.

• OptionalkeyofStringsOnly?: boolean | null

  Make keyof only return strings instead of string, numbers or symbols. Legacy option.

• Optionallib?:
      | (
          (
              | | "ES5"
              | "ES6"
              | "ES2015"
              | "ES2015.Collection"
              | "ES2015.Core"
              | "ES2015.Generator"
              | "ES2015.Iterable"
              | "ES2015.Promise"
              | "ES2015.Proxy"
              | "ES2015.Reflect"
              | "ES2015.Symbol.WellKnown"
              | "ES2015.Symbol"
              | "ES2016"
              | "ES2016.Array.Include"
              | "ES2017"
              | "ES2017.Intl"
              | "ES2017.Object"
              | "ES2017.SharedMemory"
              | "ES2017.String"
              | "ES2017.TypedArrays"
              | "ES2017.ArrayBuffer"
              | "ES2018"
              | "ES2018.AsyncGenerator"
              | "ES2018.AsyncIterable"
              | "ES2018.Intl"
              | "ES2018.Promise"
              | "ES2018.Regexp"
              | "ES2019"
              | "ES2019.Array"
              | "ES2019.Intl"
              | "ES2019.Object"
              | "ES2019.String"
              | "ES2019.Symbol"
              | "ES2020"
              | "ES2020.BigInt"
              | "ES2020.Promise"
              | "ES2020.String"
              | "ES2020.Symbol.WellKnown"
              | "ESNext"
              | "ESNext.Array"
              | "ESNext.AsyncIterable"
              | "ESNext.BigInt"
              | "ESNext.Collection"
              | "ESNext.Intl"
              | "ESNext.Iterator"
              | "ESNext.Object"
              | "ESNext.Promise"
              | "ESNext.Regexp"
              | "ESNext.String"
              | "ESNext.Symbol"
              | "DOM"
              | "DOM.AsyncIterable"
              | "DOM.Iterable"
              | "ScriptHost"
              | "WebWorker"
              | "WebWorker.AsyncIterable"
              | "WebWorker.ImportScripts"
              | "Webworker.Iterable"
              | "ES7"
              | "ES2021"
              | "ES2020.SharedMemory"
              | "ES2020.Intl"
              | "ES2020.Date"
              | "ES2020.Number"
              | "ES2021.Promise"
              | "ES2021.String"
              | "ES2021.WeakRef"
              | "ESNext.WeakRef"
              | "ES2021.Intl"
              | "ES2022"
              | "ES2022.Array"
              | "ES2022.Error"
              | "ES2022.Intl"
              | "ES2022.Object"
              | "ES2022.String"
              | "ES2022.SharedMemory"
              | "ES2022.RegExp"
              | "ES2023"
              | "ES2023.Array"
              | "ES2024"
              | "ES2024.ArrayBuffer"
              | "ES2024.Collection"
              | "ES2024.Object"
              | "ES2024.Promise"
              | "ES2024.Regexp"
              | "ES2024.SharedMemory"
              | "ES2024.String"
              | "Decorators"
              | "Decorators.Legacy"
              | "ES2017.Date"
              | "ES2023.Collection"
              | "ESNext.Decorators"
              | "ESNext.Disposable"
              | "ESNext.Error"
              | "ESNext.Sharedmemory"
              | { [k: string]: unknown }
          ) & string
      )[]
      | null

  Specify a set of bundled library declaration files that describe the target runtime environment.

• OptionallibReplacement?: boolean | null

  Enable lib replacement.

• OptionallistEmittedFiles?: boolean | null

  Print the names of emitted files after a compilation.

• OptionallistFiles?: boolean | null

  Print all of the files read during the compilation.

• OptionallistFilesOnly?: boolean | null

  Print names of files that are part of the compilation and then stop processing.

• OptionalmapRoot?: string | null

  Specify the location where debugger should locate map files instead of generated locations.

• OptionalmaxNodeModuleJsDepth?: number | null

  Specify the maximum folder depth used for checking JavaScript files from node_modules. Only applicable with allowJs.

• Optionalmodule?: (
      | | "commonjs"
      | "amd"
      | "system"
      | "umd"
      | "es6"
      | "es2015"
      | "es2020"
      | "esnext"
      | "none"
      | "es2022"
      | "node16"
      | "node18"
      | "node20"
      | "nodenext"
      | "preserve"
      | { [k: string]: unknown }
  ) & (
      | (
          | | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | { [k: string]: unknown }
      ) & string
      | (
          | | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | { [k: string]: unknown }
      ) & null
  )

  Specify what module code is generated.

• OptionalmoduleDetection?: "auto" | "legacy" | "force"

  Control what method is used to detect module-format JS files.

• OptionalmoduleResolution?: (
      | "classic"
      | "node"
      | "node10"
      | "node16"
      | "nodenext"
      | "bundler"
      | { [k: string]: unknown }
  ) & (
      | (
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | { [k: string]: unknown }
      ) & string
      | (
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | { [k: string]: unknown }
      ) & null
  )

  Specify how TypeScript looks up a file from a given module specifier.

• OptionalmoduleSuffixes?: string[] | null

  List of file name suffixes to search when resolving a module.

• OptionalnewLine?: ("crlf" | "lf" | { [k: string]: unknown }) & (
      | ((...) | (...) | { [k: string]: unknown }) & string
      | ((...) | (...) | { [k: string]: unknown }) & null
  )

  Set the newline character for emitting files.

• OptionalnoCheck?: boolean | null

  Disable full type checking (only critical parse and emit errors will be reported).

• OptionalnoEmit?: boolean | null

  Disable emitting files from a compilation.

• OptionalnoEmitHelpers?: boolean | null

  Disable generating custom helper functions like __extends in compiled output.

• OptionalnoEmitOnError?: boolean | null

  Disable emitting files if any type checking errors are reported.

• OptionalnoErrorTruncation?: boolean | null

  Disable truncating types in error messages.

• OptionalnoFallthroughCasesInSwitch?: boolean | null

  Enable error reporting for fallthrough cases in switch statements.

• OptionalnoImplicitAny?: boolean | null

  Enable error reporting for expressions and declarations with an implied any type.

• OptionalnoImplicitOverride?: boolean | null

  Ensure overriding members in derived classes are marked with an override modifier.

• OptionalnoImplicitReturns?: boolean | null

  Enable error reporting for codepaths that do not explicitly return in a function.

• OptionalnoImplicitThis?: boolean | null

  Enable error reporting when this is given the type any.

• OptionalnoImplicitUseStrict?: boolean | null

  Disable adding use strict directives in emitted JavaScript files.

• OptionalnoLib?: boolean | null

  Disable including any library files, including the default lib.d.ts.

• OptionalnoPropertyAccessFromIndexSignature?: boolean | null

  Enforces using indexed accessors for keys declared using an indexed type.

• OptionalnoResolve?: boolean | null

  Disallow imports, requires or <reference>s from expanding the number of files TypeScript should add to a project.

• OptionalnoStrictGenericChecks?: boolean | null

  Disable strict checking of generic signatures in function types.

• OptionalnoUncheckedIndexedAccess?: boolean | null

  Add undefined to a type when accessed using an index.

• OptionalnoUncheckedSideEffectImports?: boolean | null

  Check side effect imports.

• OptionalnoUnusedLocals?: boolean | null

  Enable error reporting when local variables aren't read.

• OptionalnoUnusedParameters?: boolean | null

  Raise an error when a function parameter isn't read.

• Optionalout?: string | null

  Deprecated setting. Use outFile instead.

• OptionaloutDir?: string | null

  Specify an output folder for all emitted files.

• OptionaloutFile?: string | null

  Specify a file that bundles all outputs into one JavaScript file. If declaration is true, also designates a file that bundles all .d.ts output.

• Optionalpaths?: { [k: string]: string[] } | null

  Specify a set of entries that re-map imports to additional lookup locations.

• Optionalplugins?: { name?: string }[] | null

  Specify a list of language service plugins to include.

• OptionalpreserveConstEnums?: boolean | null

  Disable erasing const enum declarations in generated code.

• OptionalpreserveSymlinks?: boolean | null

  Disable resolving symlinks to their realpath. This correlates to the same flag in node.

• OptionalpreserveValueImports?: boolean | null

  Preserve unused imported values in the JavaScript output that would otherwise be removed.

• OptionalpreserveWatchOutput?: boolean | null

  Disable wiping the console in watch mode.

• Optionalpretty?: boolean | null

  Enable color and formatting in TypeScript's output to make compiler errors easier to read.

• OptionalreactNamespace?: string | null

  Specify the object invoked for createElement. This only applies when targeting react JSX emit.

• OptionalremoveComments?: boolean | null

  Disable emitting comments.

• OptionalresolveJsonModule?: boolean | null

  Enable importing .json files.

• OptionalresolvePackageJsonExports?: boolean | null

  Use the package.json 'exports' field when resolving package imports.

• OptionalresolvePackageJsonImports?: boolean | null

  Use the package.json 'imports' field when resolving imports.

• OptionalrewriteRelativeImportExtensions?: boolean | null

  Rewrite .ts, .tsx, .mts, and .cts file extensions in relative import paths to their JavaScript equivalent in output files.

• OptionalrootDir?: string | null

  Specify the root folder within your source files.

• OptionalrootDirs?: string[] | null

  Allow multiple folders to be treated as one when resolving modules.

• OptionalskipDefaultLibCheck?: boolean | null

  Skip type checking .d.ts files that are included with TypeScript.

• OptionalskipLibCheck?: boolean | null

  Skip type checking all .d.ts files.

• OptionalsourceMap?: boolean | null

  Create source map files for emitted JavaScript files.

• OptionalsourceRoot?: string | null

  Specify the root path for debuggers to find the reference source code.

• Optionalstrict?: boolean | null

  Enable all strict type-checking options.

• OptionalstrictBindCallApply?: boolean | null

  Check that the arguments for bind, call, and apply methods match the original function.

• OptionalstrictBuiltinIteratorReturn?: boolean | null

  Built-in iterators are instantiated with a TReturn type of undefined instead of any.

• OptionalstrictFunctionTypes?: boolean | null

  When assigning functions, check to ensure parameters and the return values are subtype-compatible.

• OptionalstrictNullChecks?: boolean | null

  When type checking, take into account null and undefined.

• OptionalstrictPropertyInitialization?: boolean | null

  Check for class properties that are declared but not set in the constructor.

• OptionalstripInternal?: boolean | null

  Disable emitting declarations that have @internal in their JSDoc comments.

• OptionalsuppressExcessPropertyErrors?: boolean | null

  Disable reporting of excess property errors during the creation of object literals.

• OptionalsuppressImplicitAnyIndexErrors?: boolean | null

  Suppress noImplicitAny errors when indexing objects that lack index signatures.

• Optionaltarget?: (
      | | "es3"
      | "es5"
      | "es6"
      | "es2015"
      | "es2016"
      | "es2017"
      | "es2018"
      | "es2019"
      | "es2020"
      | "es2021"
      | "es2022"
      | "es2023"
      | "es2024"
      | "esnext"
      | { [k: string]: unknown }
  ) & (
      | (
          | | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | { [k: string]: unknown }
      ) & string
      | (
          | | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | (...)
          | { [k: string]: unknown }
      ) & null
  )

  Set the JavaScript language version for emitted JavaScript and include compatible library declarations.

• OptionaltraceResolution?: boolean | null

  Log paths used during the moduleResolution process.

• OptionaltsBuildInfoFile?: string | null

  Specify the path to .tsbuildinfo incremental compilation file.

• OptionaltypeRoots?: string[] | null

  Specify multiple folders that act like ./node_modules/@types.

• Optionaltypes?: string[] | null

  Specify type package names to be included without being referenced in a source file.

• OptionaluseDefineForClassFields?: boolean | null

  Emit ECMAScript-standard-compliant class fields.

• OptionaluseUnknownInCatchVariables?: boolean | null

  Default catch clause variables as unknown instead of any.

• OptionalverbatimModuleSyntax?: boolean | null

  Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the module setting.

• Optionalwatch?: boolean | null

  Watch input files.

• OptionalwatchDirectory?:
      | "useFsEvents"
      | "fixedPollingInterval"
      | "dynamicPriorityPolling"
      | "fixedChunkSizePolling"

  Specify the strategy for watching directories under systems that lack recursive file-watching functionality. Requires TypeScript version 3.8 or later.

• OptionalwatchFile?:
      | "fixedPollingInterval"
      | "priorityPollingInterval"
      | "dynamicPriorityPolling"
      | "useFsEvents"
      | "useFsEventsOnParentDirectory"
      | "fixedChunkSizePolling"

  Specify the strategy for watching individual files. Requires TypeScript version 3.8 or later.

• {
      allowArbitraryExtensions?: boolean | null;
      allowImportingTsExtensions?: boolean | null;
      allowJs?: boolean | null;
      allowSyntheticDefaultImports?: boolean | null;
      allowUmdGlobalAccess?: boolean | null;
      allowUnreachableCode?: boolean | null;
      allowUnusedLabels?: boolean | null;
      alwaysStrict?: boolean | null;
      assumeChangesOnlyAffectDirectDependencies?: boolean | null;
      baseUrl?: string | null;
      charset?: string | null;
      checkJs?: boolean | null;
      composite?: boolean | null;
      customConditions?: string[] | null;
      declaration?: boolean | null;
      declarationDir?: string | null;
      declarationMap?: boolean | null;
      diagnostics?: boolean | null;
      disableReferencedProjectLoad?: boolean | null;
      disableSizeLimit?: boolean | null;
      disableSolutionSearching?: boolean | null;
      disableSourceOfProjectReferenceRedirect?: boolean | null;
      downlevelIteration?: boolean | null;
      emitBOM?: boolean | null;
      emitDeclarationOnly?: boolean | null;
      emitDecoratorMetadata?: boolean | null;
      erasableSyntaxOnly?: boolean | null;
      esModuleInterop?: boolean | null;
      exactOptionalPropertyTypes?: boolean | null;
      experimentalDecorators?: boolean | null;
      extendedDiagnostics?: boolean | null;
      fallbackPolling?:
          | "fixedPollingInterval"
          | "priorityPollingInterval"
          | "dynamicPriorityPolling"
          | "fixedInterval"
          | "priorityInterval"
          | "dynamicPriority"
          | "fixedChunkSize";
      forceConsistentCasingInFileNames?: boolean
      | null;
      generateCpuProfile?: string | null;
      importHelpers?: boolean | null;
      importsNotUsedAsValues?: "remove" | "preserve" | "error";
      incremental?: boolean | null;
      inlineSourceMap?: boolean | null;
      inlineSources?: boolean | null;
      isolatedDeclarations?: boolean | null;
      isolatedModules?: boolean | null;
      jsx?: "preserve" | "react" | "react-jsx" | "react-jsxdev" | "react-native";
      jsxFactory?: string | null;
      jsxFragmentFactory?: string | null;
      jsxImportSource?: string | null;
      keyofStringsOnly?: boolean | null;
      lib?: (((...) | { [k: ...]: ... }) & string)[] | null;
      libReplacement?: boolean | null;
      listEmittedFiles?: boolean | null;
      listFiles?: boolean | null;
      listFilesOnly?: boolean | null;
      mapRoot?: string | null;
      maxNodeModuleJsDepth?: number | null;
      module?: (
          | | "commonjs"
          | "amd"
          | "system"
          | "umd"
          | "es6"
          | "es2015"
          | "es2020"
          | "esnext"
          | "none"
          | "es2022"
          | "node16"
          | "node18"
          | "node20"
          | "nodenext"
          | "preserve"
          | { [k: string]: unknown }
      ) & (((...) | (...)) & string | ((...) | (...)) & null);
      moduleDetection?: "auto" | "legacy" | "force";
      moduleResolution?: (
          | "classic"
          | "node"
          | "node10"
          | "node16"
          | "nodenext"
          | "bundler"
          | { [k: string]: unknown }
      ) & (((...) | (...)) & string | ((...) | (...)) & null);
      moduleSuffixes?: string[] | null;
      newLine?: ("crlf" | "lf" | { [k: string]: unknown }) & (
          ((...) | (...)) & string
          | ((...) | (...)) & null
      );
      noCheck?: boolean | null;
      noEmit?: boolean | null;
      noEmitHelpers?: boolean | null;
      noEmitOnError?: boolean | null;
      noErrorTruncation?: boolean | null;
      noFallthroughCasesInSwitch?: boolean | null;
      noImplicitAny?: boolean | null;
      noImplicitOverride?: boolean | null;
      noImplicitReturns?: boolean | null;
      noImplicitThis?: boolean | null;
      noImplicitUseStrict?: boolean | null;
      noLib?: boolean | null;
      noPropertyAccessFromIndexSignature?: boolean | null;
      noResolve?: boolean | null;
      noStrictGenericChecks?: boolean | null;
      noUncheckedIndexedAccess?: boolean | null;
      noUncheckedSideEffectImports?: boolean | null;
      noUnusedLocals?: boolean | null;
      noUnusedParameters?: boolean | null;
      out?: string | null;
      outDir?: string | null;
      outFile?: string | null;
      paths?: { [k: string]: string[] } | null;
      plugins?: { name?: string }[] | null;
      preserveConstEnums?: boolean | null;
      preserveSymlinks?: boolean | null;
      preserveValueImports?: boolean | null;
      preserveWatchOutput?: boolean | null;
      pretty?: boolean | null;
      reactNamespace?: string | null;
      removeComments?: boolean | null;
      resolveJsonModule?: boolean | null;
      resolvePackageJsonExports?: boolean | null;
      resolvePackageJsonImports?: boolean | null;
      rewriteRelativeImportExtensions?: boolean | null;
      rootDir?: string | null;
      rootDirs?: string[] | null;
      skipDefaultLibCheck?: boolean | null;
      skipLibCheck?: boolean | null;
      sourceMap?: boolean | null;
      sourceRoot?: string | null;
      strict?: boolean | null;
      strictBindCallApply?: boolean | null;
      strictBuiltinIteratorReturn?: boolean | null;
      strictFunctionTypes?: boolean | null;
      strictNullChecks?: boolean | null;
      strictPropertyInitialization?: boolean | null;
      stripInternal?: boolean | null;
      suppressExcessPropertyErrors?: boolean | null;
      suppressImplicitAnyIndexErrors?: boolean | null;
      target?: (
          | | "es3"
          | "es5"
          | "es6"
          | "es2015"
          | "es2016"
          | "es2017"
          | "es2018"
          | "es2019"
          | "es2020"
          | "es2021"
          | "es2022"
          | "es2023"
          | "es2024"
          | "esnext"
          | { [k: string]: unknown }
      ) & (((...) | (...)) & string | ((...) | (...)) & null);
      traceResolution?: boolean | null;
      tsBuildInfoFile?: string | null;
      typeRoots?: string[] | null;
      types?: string[] | null;
      useDefineForClassFields?: boolean | null;
      useUnknownInCatchVariables?: boolean | null;
      verbatimModuleSyntax?: boolean | null;
      watch?: boolean | null;
      watchDirectory?:
          | "useFsEvents"
          | "fixedPollingInterval"
          | "dynamicPriorityPolling"
          | "fixedChunkSizePolling";
      watchFile?: | "fixedPollingInterval"
      | "priorityPollingInterval"
      | "dynamicPriorityPolling"
      | "useFsEvents"
      | "useFsEventsOnParentDirectory"
      | "fixedChunkSizePolling";
  }

  • OptionalallowArbitraryExtensions?: boolean | null

    Enable importing files with any extension, provided a declaration file is present.

  • OptionalallowImportingTsExtensions?: boolean | null

    Allow imports to include TypeScript file extensions. Requires --moduleResolution bundler and either --noEmit or --emitDeclarationOnly to be set.

  • OptionalallowJs?: boolean | null

    Allow JavaScript files to be a part of your program. Use the checkJs option to get errors from these files.

  • OptionalallowSyntheticDefaultImports?: boolean | null

    Allow import x from y when a module doesn't have a default export.

  • OptionalallowUmdGlobalAccess?: boolean | null

    Allow accessing UMD globals from modules.

  • OptionalallowUnreachableCode?: boolean | null

    Disable error reporting for unreachable code.

  • OptionalallowUnusedLabels?: boolean | null

    Disable error reporting for unused labels.

  • OptionalalwaysStrict?: boolean | null

    Ensure use strict is always emitted.

  • OptionalassumeChangesOnlyAffectDirectDependencies?: boolean | null

    Have recompiles in projects that use incremental and watch mode assume that changes within a file will only affect files directly depending on it.

  • OptionalbaseUrl?: string | null

    Specify the base directory to resolve non-relative module names.

  • Optionalcharset?: string | null

    No longer supported. In early versions, manually set the text encoding for reading files.

  • OptionalcheckJs?: boolean | null

    Enable error reporting in type-checked JavaScript files.

  • Optionalcomposite?: boolean | null

    Enable constraints that allow a TypeScript project to be used with project references.

  • OptionalcustomConditions?: string[] | null

    Conditions to set in addition to the resolver-specific defaults when resolving imports.

  • Optionaldeclaration?: boolean | null

    Generate .d.ts files from TypeScript and JavaScript files in your project.

  • OptionaldeclarationDir?: string | null

    Specify the output directory for generated declaration files.

  • OptionaldeclarationMap?: boolean | null

    Create sourcemaps for d.ts files.

  • Optionaldiagnostics?: boolean | null

    Output compiler performance information after building.

  • OptionaldisableReferencedProjectLoad?: boolean | null

    Reduce the number of projects loaded automatically by TypeScript.

  • OptionaldisableSizeLimit?: boolean | null

    Remove the 20mb cap on total source code size for JavaScript files in the TypeScript language server.

  • OptionaldisableSolutionSearching?: boolean | null

    Opt a project out of multi-project reference checking when editing.

  • OptionaldisableSourceOfProjectReferenceRedirect?: boolean | null

    Disable preferring source files instead of declaration files when referencing composite projects.

  • OptionaldownlevelIteration?: boolean | null

    Emit more compliant, but verbose and less performant JavaScript for iteration.

  • OptionalemitBOM?: boolean | null

    Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files.

  • OptionalemitDeclarationOnly?: boolean | null

    Only output d.ts files and not JavaScript files.

  • OptionalemitDecoratorMetadata?: boolean | null

    Emit design-type metadata for decorated declarations in source files.

  • OptionalerasableSyntaxOnly?: boolean | null

    Do not allow runtime constructs that are not part of ECMAScript.

  • OptionalesModuleInterop?: boolean | null

    Emit additional JavaScript to ease support for importing CommonJS modules. This enables allowSyntheticDefaultImports for type compatibility.

  • OptionalexactOptionalPropertyTypes?: boolean | null

    Interpret optional property types as written, rather than adding undefined.

  • OptionalexperimentalDecorators?: boolean | null

    Enable experimental support for legacy experimental decorators.

  • OptionalextendedDiagnostics?: boolean | null

    Output more detailed compiler performance information after building.

  • OptionalfallbackPolling?:
        | "fixedPollingInterval"
        | "priorityPollingInterval"
        | "dynamicPriorityPolling"
        | "fixedInterval"
        | "priorityInterval"
        | "dynamicPriority"
        | "fixedChunkSize"

    Specify the polling strategy to use when the system runs out of or doesn't support native file watchers. Requires TypeScript version 3.8 or later.

  • OptionalforceConsistentCasingInFileNames?: boolean | null

    Ensure that casing is correct in imports.

  • OptionalgenerateCpuProfile?: string | null

    Emit a v8 CPU profile of the compiler run for debugging.

  • OptionalimportHelpers?: boolean | null

    Allow importing helper functions from tslib once per project, instead of including them per-file.

  • OptionalimportsNotUsedAsValues?: "remove" | "preserve" | "error"

    Specify emit/checking behavior for imports that are only used for types.

  • Optionalincremental?: boolean | null

    Enable incremental compilation. Requires TypeScript version 3.4 or later.

  • OptionalinlineSourceMap?: boolean | null

    Include sourcemap files inside the emitted JavaScript.

  • OptionalinlineSources?: boolean | null

    Include source code in the sourcemaps inside the emitted JavaScript.

  • OptionalisolatedDeclarations?: boolean | null

    Require sufficient annotation on exports so other tools can trivially generate declaration files.

  • OptionalisolatedModules?: boolean | null

    Ensure that each file can be safely transpiled without relying on other imports.

  • Optionaljsx?: "preserve" | "react" | "react-jsx" | "react-jsxdev" | "react-native"

    Specify what JSX code is generated.

  • OptionaljsxFactory?: string | null

    Specify the JSX factory function used when targeting React JSX emit, e.g. React.createElement or h.

  • OptionaljsxFragmentFactory?: string | null

    Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. React.Fragment or Fragment.

  • OptionaljsxImportSource?: string | null

    Specify module specifier used to import the JSX factory functions when using jsx: react-jsx.

  • OptionalkeyofStringsOnly?: boolean | null

    Make keyof only return strings instead of string, numbers or symbols. Legacy option.

  • Optionallib?: (((...) | { [k: ...]: ... }) & string)[] | null

    Specify a set of bundled library declaration files that describe the target runtime environment.

  • OptionallibReplacement?: boolean | null

    Enable lib replacement.

  • OptionallistEmittedFiles?: boolean | null

    Print the names of emitted files after a compilation.

  • OptionallistFiles?: boolean | null

    Print all of the files read during the compilation.

  • OptionallistFilesOnly?: boolean | null

    Print names of files that are part of the compilation and then stop processing.

  • OptionalmapRoot?: string | null

    Specify the location where debugger should locate map files instead of generated locations.

  • OptionalmaxNodeModuleJsDepth?: number | null

    Specify the maximum folder depth used for checking JavaScript files from node_modules. Only applicable with allowJs.

  • Optionalmodule?: (
        | | "commonjs"
        | "amd"
        | "system"
        | "umd"
        | "es6"
        | "es2015"
        | "es2020"
        | "esnext"
        | "none"
        | "es2022"
        | "node16"
        | "node18"
        | "node20"
        | "nodenext"
        | "preserve"
        | { [k: string]: unknown }
    ) & (((...) | (...)) & string | ((...) | (...)) & null)

    Specify what module code is generated.

  • OptionalmoduleDetection?: "auto" | "legacy" | "force"

    Control what method is used to detect module-format JS files.

  • OptionalmoduleResolution?: (
        | "classic"
        | "node"
        | "node10"
        | "node16"
        | "nodenext"
        | "bundler"
        | { [k: string]: unknown }
    ) & (((...) | (...)) & string | ((...) | (...)) & null)

    Specify how TypeScript looks up a file from a given module specifier.

  • OptionalmoduleSuffixes?: string[] | null

    List of file name suffixes to search when resolving a module.

  • OptionalnewLine?: ("crlf" | "lf" | { [k: string]: unknown }) & (
        ((...) | (...)) & string
        | ((...) | (...)) & null
    )

    Set the newline character for emitting files.

  • OptionalnoCheck?: boolean | null

    Disable full type checking (only critical parse and emit errors will be reported).

  • OptionalnoEmit?: boolean | null

    Disable emitting files from a compilation.

  • OptionalnoEmitHelpers?: boolean | null

    Disable generating custom helper functions like __extends in compiled output.

  • OptionalnoEmitOnError?: boolean | null

    Disable emitting files if any type checking errors are reported.

  • OptionalnoErrorTruncation?: boolean | null

    Disable truncating types in error messages.

  • OptionalnoFallthroughCasesInSwitch?: boolean | null

    Enable error reporting for fallthrough cases in switch statements.

  • OptionalnoImplicitAny?: boolean | null

    Enable error reporting for expressions and declarations with an implied any type.

  • OptionalnoImplicitOverride?: boolean | null

    Ensure overriding members in derived classes are marked with an override modifier.

  • OptionalnoImplicitReturns?: boolean | null

    Enable error reporting for codepaths that do not explicitly return in a function.

  • OptionalnoImplicitThis?: boolean | null

    Enable error reporting when this is given the type any.

  • OptionalnoImplicitUseStrict?: boolean | null

    Disable adding use strict directives in emitted JavaScript files.

  • OptionalnoLib?: boolean | null

    Disable including any library files, including the default lib.d.ts.

  • OptionalnoPropertyAccessFromIndexSignature?: boolean | null

    Enforces using indexed accessors for keys declared using an indexed type.

  • OptionalnoResolve?: boolean | null

    Disallow imports, requires or <reference>s from expanding the number of files TypeScript should add to a project.

  • OptionalnoStrictGenericChecks?: boolean | null

    Disable strict checking of generic signatures in function types.

  • OptionalnoUncheckedIndexedAccess?: boolean | null

    Add undefined to a type when accessed using an index.

  • OptionalnoUncheckedSideEffectImports?: boolean | null

    Check side effect imports.

  • OptionalnoUnusedLocals?: boolean | null

    Enable error reporting when local variables aren't read.

  • OptionalnoUnusedParameters?: boolean | null

    Raise an error when a function parameter isn't read.

  • Optionalout?: string | null

    Deprecated setting. Use outFile instead.

  • OptionaloutDir?: string | null

    Specify an output folder for all emitted files.

  • OptionaloutFile?: string | null

    Specify a file that bundles all outputs into one JavaScript file. If declaration is true, also designates a file that bundles all .d.ts output.

  • Optionalpaths?: { [k: string]: string[] } | null

    Specify a set of entries that re-map imports to additional lookup locations.

  • Optionalplugins?: { name?: string }[] | null

    Specify a list of language service plugins to include.

  • OptionalpreserveConstEnums?: boolean | null

    Disable erasing const enum declarations in generated code.

  • OptionalpreserveSymlinks?: boolean | null

    Disable resolving symlinks to their realpath. This correlates to the same flag in node.

  • OptionalpreserveValueImports?: boolean | null

    Preserve unused imported values in the JavaScript output that would otherwise be removed.

  • OptionalpreserveWatchOutput?: boolean | null

    Disable wiping the console in watch mode.

  • Optionalpretty?: boolean | null

    Enable color and formatting in TypeScript's output to make compiler errors easier to read.

  • OptionalreactNamespace?: string | null

    Specify the object invoked for createElement. This only applies when targeting react JSX emit.

  • OptionalremoveComments?: boolean | null

    Disable emitting comments.

  • OptionalresolveJsonModule?: boolean | null

    Enable importing .json files.

  • OptionalresolvePackageJsonExports?: boolean | null

    Use the package.json 'exports' field when resolving package imports.

  • OptionalresolvePackageJsonImports?: boolean | null

    Use the package.json 'imports' field when resolving imports.

  • OptionalrewriteRelativeImportExtensions?: boolean | null

    Rewrite .ts, .tsx, .mts, and .cts file extensions in relative import paths to their JavaScript equivalent in output files.

  • OptionalrootDir?: string | null

    Specify the root folder within your source files.

  • OptionalrootDirs?: string[] | null

    Allow multiple folders to be treated as one when resolving modules.

  • OptionalskipDefaultLibCheck?: boolean | null

    Skip type checking .d.ts files that are included with TypeScript.

  • OptionalskipLibCheck?: boolean | null

    Skip type checking all .d.ts files.

  • OptionalsourceMap?: boolean | null

    Create source map files for emitted JavaScript files.

  • OptionalsourceRoot?: string | null

    Specify the root path for debuggers to find the reference source code.

  • Optionalstrict?: boolean | null

    Enable all strict type-checking options.

  • OptionalstrictBindCallApply?: boolean | null

    Check that the arguments for bind, call, and apply methods match the original function.

  • OptionalstrictBuiltinIteratorReturn?: boolean | null

    Built-in iterators are instantiated with a TReturn type of undefined instead of any.

  • OptionalstrictFunctionTypes?: boolean | null

    When assigning functions, check to ensure parameters and the return values are subtype-compatible.

  • OptionalstrictNullChecks?: boolean | null

    When type checking, take into account null and undefined.

  • OptionalstrictPropertyInitialization?: boolean | null

    Check for class properties that are declared but not set in the constructor.

  • OptionalstripInternal?: boolean | null

    Disable emitting declarations that have @internal in their JSDoc comments.

  • OptionalsuppressExcessPropertyErrors?: boolean | null

    Disable reporting of excess property errors during the creation of object literals.

  • OptionalsuppressImplicitAnyIndexErrors?: boolean | null

    Suppress noImplicitAny errors when indexing objects that lack index signatures.

  • Optionaltarget?: (
        | | "es3"
        | "es5"
        | "es6"
        | "es2015"
        | "es2016"
        | "es2017"
        | "es2018"
        | "es2019"
        | "es2020"
        | "es2021"
        | "es2022"
        | "es2023"
        | "es2024"
        | "esnext"
        | { [k: string]: unknown }
    ) & (((...) | (...)) & string | ((...) | (...)) & null)

    Set the JavaScript language version for emitted JavaScript and include compatible library declarations.

  • OptionaltraceResolution?: boolean | null

    Log paths used during the moduleResolution process.

  • OptionaltsBuildInfoFile?: string | null

    Specify the path to .tsbuildinfo incremental compilation file.

  • OptionaltypeRoots?: string[] | null

    Specify multiple folders that act like ./node_modules/@types.

  • Optionaltypes?: string[] | null

    Specify type package names to be included without being referenced in a source file.

  • OptionaluseDefineForClassFields?: boolean | null

    Emit ECMAScript-standard-compliant class fields.

  • OptionaluseUnknownInCatchVariables?: boolean | null

    Default catch clause variables as unknown instead of any.

  • OptionalverbatimModuleSyntax?: boolean | null

    Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the module setting.

  • Optionalwatch?: boolean | null

    Watch input files.

  • OptionalwatchDirectory?:
        | "useFsEvents"
        | "fixedPollingInterval"
        | "dynamicPriorityPolling"
        | "fixedChunkSizePolling"

    Specify the strategy for watching directories under systems that lack recursive file-watching functionality. Requires TypeScript version 3.8 or later.

  • OptionalwatchFile?:
        | "fixedPollingInterval"
        | "priorityPollingInterval"
        | "dynamicPriorityPolling"
        | "useFsEvents"
        | "useFsEventsOnParentDirectory"
        | "fixedChunkSizePolling"

    Specify the strategy for watching individual files. Requires TypeScript version 3.8 or later.

• null