schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
tsconfig.json
noEmitHelpers
Disable generating custom helper functions like `__extends` in compiled output.
{"type": "boolean", "default": false}
tsconfig.json
noEmitOnError
Disable emitting files if any type checking errors are reported.
{"type": "boolean", "default": false}
tsconfig.json
noImplicitAny
Enable error reporting for expressions and declarations with an implied `any` type..
{"type": "boolean"}
tsconfig.json
noImplicitThis
Enable error reporting when `this` is given the type `any`.
{"type": "boolean"}
tsconfig.json
noUnusedLocals
Enable error reporting when a local variables aren't read.
{"type": "boolean", "default": false}
tsconfig.json
noUnusedParameters
Raise an error when a function parameter isn't read
{"type": "boolean", "default": false}
tsconfig.json
noLib
Disable including any library files, including the default lib.d.ts.
{"type": "boolean", "default": false}
tsconfig.json
noResolve
Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project.
{"type": "boolean", "default": false}
tsconfig.json
noStrictGenericChecks
Disable strict checking of generic signatures in function types.
{"type": "boolean", "default": false}
tsconfig.json
skipDefaultLibCheck
Skip type checking .d.ts files that are included with TypeScript.
{"type": "boolean", "default": false}
tsconfig.json
skipLibCheck
Skip type checking all .d.ts files.
{"type": "boolean", "default": false}
tsconfig.json
outFile
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.
{"type": "string"}
tsconfig.json
outDir
Specify an output folder for all emitted files.
{"type": "string"}
tsconfig.json
preserveConstEnums
Disable erasing `const enum` declarations in generated code.
{"type": "boolean", "default": false}
tsconfig.json
preserveSymlinks
Disable resolving symlinks to their realpath. This correlates to the same flag in node.
{"type": "boolean", "default": false}
tsconfig.json
preserveValueImports
Preserve unused imported values in the JavaScript output that would otherwise be removed
{"type": "boolean", "default": false}
tsconfig.json
preserveWatchOutput
Disable wiping the console in watch mode
{"type": "boolean"}
tsconfig.json
pretty
Enable color and formatting in output to make compiler errors easier to read
{"type": "boolean", "default": true}
tsconfig.json
removeComments
Disable emitting comments.
{"type": "boolean", "default": false}
tsconfig.json
rootDir
Specify the root folder within your source files.
{"type": "string"}
tsconfig.json
isolatedModules
Ensure that each file can be safely transpiled without relying on other imports.
{"type": "boolean", "default": false}
tsconfig.json
sourceMap
Create source map files for emitted JavaScript files.
{"type": "boolean", "default": false}
tsconfig.json
sourceRoot
Specify the root path for debuggers to find the reference source code.
{"type": "string"}
tsconfig.json
suppressExcessPropertyErrors
Disable reporting of excess property errors during the creation of object literals.
{"type": "boolean", "default": false}
tsconfig.json
suppressImplicitAnyIndexErrors
Suppress `noImplicitAny` errors when indexing objects that lack index signatures.
{"type": "boolean", "default": false}
tsconfig.json
stripInternal
Disable emitting declarations that have `@internal` in their JSDoc comments.
{"type": "boolean"}
tsconfig.json
target
Set the JavaScript language version for emitted JavaScript and include compatible library declarations.
{"type": "string", "default": "ES3", "anyOf": [{"enum": ["ES3", "ES5", "ES6", "ES2015", "ES2016", "ES2017", "ES2018", "ES2019", "ES2020", "ES2021", "ES2022", "ES2023", "ESNext"]}, {"pattern": "^([Ee][Ss]([356]|(20(1[56789]|2[0123]))|[Nn][Ee][Xx][Tt]))$"}]}
tsconfig.json
useUnknownInCatchVariables
Default catch clause variables as `unknown` instead of `any`.
{"type": "boolean", "default": false}
tsconfig.json
watch
Watch input files.
{"type": "boolean"}
tsconfig.json
fallbackPolling
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.
{"enum": ["fixedPollingInterval", "priorityPollingInterval", "dynamicPriorityPolling", "fixedInterval", "priorityInterval", "dynamicPriority", "fixedChunkSize"]}
tsconfig.json
watchDirectory
Specify the strategy for watching directories under systems that lack recursive file-watching functionality. Requires TypeScript version 3.8 or later.
{"enum": ["useFsEvents", "fixedPollingInterval", "dynamicPriorityPolling", "fixedChunkSizePolling"], "default": "useFsEvents"}
tsconfig.json
watchFile
Specify the strategy for watching individual files. Requires TypeScript version 3.8 or later.
{"enum": ["fixedPollingInterval", "priorityPollingInterval", "dynamicPriorityPolling", "useFsEvents", "useFsEventsOnParentDirectory", "fixedChunkSizePolling"], "default": "useFsEvents"}
tsconfig.json
experimentalDecorators
Enable experimental support for TC39 stage 2 draft decorators.
{"type": "boolean"}
tsconfig.json
emitDecoratorMetadata
Emit design-type metadata for decorated declarations in source files.
{"type": "boolean"}
tsconfig.json
allowUnusedLabels
Disable error reporting for unused labels.
{"type": "boolean"}
tsconfig.json
noImplicitReturns
Enable error reporting for codepaths that do not explicitly return in a function.
{"type": "boolean", "default": false}
tsconfig.json
noUncheckedIndexedAccess
Add `undefined` to a type when accessed using an index.
{"type": "boolean"}
tsconfig.json
noFallthroughCasesInSwitch
Enable error reporting for fallthrough cases in switch statements.
{"type": "boolean", "default": false}
tsconfig.json
noImplicitOverride
Ensure overriding members in derived classes are marked with an override modifier.
{"type": "boolean", "default": false}
tsconfig.json
allowUnreachableCode
Disable error reporting for unreachable code.
{"type": "boolean"}
tsconfig.json
forceConsistentCasingInFileNames
Ensure that casing is correct in imports.
{"type": "boolean", "default": false}
tsconfig.json
generateCpuProfile
Emit a v8 CPU profile of the compiler run for debugging.
{"type": "string", "default": "profile.cpuprofile"}
tsconfig.json
baseUrl
Specify the base directory to resolve non-relative module names.
{"type": "string"}
tsconfig.json
paths
Specify a set of entries that re-map imports to additional lookup locations.
{"type": "object", "additionalProperties": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}}
tsconfig.json
items
Path mapping to be computed relative to baseUrl option.
{"type": "string"}
tsconfig.json
plugins
Specify a list of language service plugins to include.
{"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}}}}
tsconfig.json
name
Plugin name.
{"type": "string"}
tsconfig.json
rootDirs
Allow multiple folders to be treated as one when resolving modules.
{"type": "array", "uniqueItems": true, "items": {"type": "string"}}
tsconfig.json
typeRoots
Specify multiple folders that act like `./node_modules/@types`.
{"type": "array", "uniqueItems": true, "items": {"type": "string"}}
tsconfig.json
types
Specify type package names to be included without being referenced in a source file.
{"type": "array", "uniqueItems": true, "items": {"type": "string"}}
tsconfig.json
traceResolution
Enable tracing of the name resolution process. Requires TypeScript version 2.0 or later.
{"type": "boolean", "default": false}
tsconfig.json
allowJs
Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files.
{"type": "boolean", "default": false}
tsconfig.json
noErrorTruncation
Disable truncating types in error messages.
{"type": "boolean", "default": false}
tsconfig.json
allowSyntheticDefaultImports
Allow 'import x from y' when a module doesn't have a default export.
{"type": "boolean"}
tsconfig.json
noImplicitUseStrict
Disable adding 'use strict' directives in emitted JavaScript files.
{"type": "boolean", "default": false}
tsconfig.json
listEmittedFiles
Print the names of emitted files after a compilation.
{"type": "boolean", "default": false}
tsconfig.json
disableSizeLimit
Remove the 20mb cap on total source code size for JavaScript files in the TypeScript language server.
{"type": "boolean", "default": false}
tsconfig.json
lib
Specify a set of bundled library declaration files that describe the target runtime environment.
{"type": "array", "uniqueItems": true, "items": {"type": "string", "anyOf": [{"enum": ["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", "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.Intl", "ESNext.Promise", "ESNext.String", "ESNext.Symbol", "DOM", "DOM.Iterable", "ScriptHost", "WebWorker", "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"]}, {"pattern": "^[Ee][Ss]5|[Ee][Ss]6|[Ee][Ss]7$"}, {"pattern": "^[Ee][Ss]2015(\\.([Cc][Oo][Ll][Ll][Ee][Cc][Tt][Ii][Oo][Nn]|[Cc][Oo][Rr][Ee]|[Gg][Ee][Nn][Ee][Rr][Aa][Tt][Oo][Rr]|[Ii][Tt][Ee][Rr][Aa][Bb][Ll][Ee]|[Pp][Rr][Oo][Mm][Ii][Ss][Ee]|[Pp][Rr][Oo][Xx][Yy]|[Rr][Ee][Ff][Ll][Ee][Cc][Tt]|[Ss][Yy][Mm][Bb][Oo][Ll].[Ww][Ee][Ll][Ll][Kk][Nn][Oo][Ww][Nn]|[Ss][Yy][Mm][Bb][Oo][Ll]))?$"}, {"pattern": "^[Ee][Ss]2016(\\.[Aa][Rr][Rr][Aa][Yy].[Ii][Nn][Cc][Ll][Uu][Dd][Ee])?$"}, {"pattern": "^[Ee][Ss]2017(\\.([Ii][Nn][Tt][Ll]|[Oo][Bb][Jj][Ee][Cc][Tt]|[Ss][Hh][Aa][Rr][Ee][Dd][Mm][Ee][Mm][Oo][Rr][Yy]|[Ss][Tt][Rr][Ii][Nn][Gg]|[Tt][Yy][Pp][Ee][Dd][Aa][Rr][Rr][Aa][Yy][Ss]))?$"}, {"pattern": "^[Ee][Ss]2018(\\.([Aa][Ss][Yy][Nn][Cc][Ii][Tt][Ee][Rr][Aa][Bb][Ll][Ee]|[Ii][Nn][Tt][Ll]|[Pp][Rr][Oo][Mm][Ii][Ss][Ee]|[Rr][Ee][Gg][Ee][Xx][Pp]))?$"}, {"pattern": "^[Ee][Ss]2019(\\.([Aa][Rr][Rr][Aa][Yy]|[Oo][Bb][Jj][Ee][Cc][Tt]|[Ss][Tt][Rr][Ii][Nn][Gg]|[Ss][Yy][Mm][Bb][Oo][Ll]))?$"}, {"pattern": "^[Ee][Ss]2020(\\.([Bb][Ii][Gg][Ii][Nn][Tt]|[Pp][Rr][Oo][Mm][Ii][Ss][Ee]|[Ss][Tt][Rr][Ii][Nn][Gg]|[Ss][Yy][Mm][Bb][Oo][Ll].[Ww][Ee][Ll][Ll][Kk][Nn][Oo][Ww][Nn]|[Dd][Aa][Tt][Ee]|[Nn][Uu][Mm][Bb][Ee][Rr]))?$"}, {"pattern": "^[Ee][Ss]2021(\\.([Ii][Nn][Tt][Ll]|[Pp][Rr][Oo][Mm][Ii][Ss][Ee]|[Ss][Tt][Rr][Ii][Nn][Gg]|[Ww][Ee][Aa][Kk][Rr][Ee][Ff]))?$"}, {"pattern": "^[Ee][Ss]2022(\\.([Aa][Rr][Rr][Aa][Yy]|[Ee][Rr][Rr][Oo][Rr]|[Ii][Nn][Tt][Ll]|[Oo][Bb][Jj][Ee][Cc][Tt]|[Ss][Tt][Rr][Ii][Nn][Gg]|[Ss][Hh][Aa][Rr][Ee][Dd][Mm][Ee][Mm][Oo][Rr][Yy]|[Rr][Ee][Gg][Ee][Xx][Pp]))?$"}, {"pattern": "^[Ee][Ss]2023(\\.([Aa][Rr][Rr][Aa][Yy]))?$"}, {"pattern": "^[Ee][Ss][Nn][Ee][Xx][Tt](\\.([Aa][Rr][Rr][Aa][Yy]|[Aa][Ss][Yy][Nn][Cc][Ii][Tt][Ee][Rr][Aa][Bb][Ll][Ee]|[Bb][Ii][Gg][Ii][Nn][Tt]|[Ii][Nn][Tt][Ll]|[Pp][Rr][Oo][Mm][Ii][Ss][Ee]|[Ss][Tt][Rr][Ii][Nn][Gg]|[Ss][Yy][Mm][Bb][Oo][Ll]|[Ww][Ee][Aa][Kk][Rr][Ee][Ff]))?$"}, {"pattern": "^[Dd][Oo][Mm](\\.[Ii][Tt][Ee][Rr][Aa][Bb][Ll][Ee])?$"}, {"pattern": "^[Ss][Cc][Rr][Ii][Pp][Tt][Hh][Oo][Ss][Tt]$"}, {"pattern": "^[Ww][Ee][Bb][Ww][Oo][Rr][Kk][Ee][Rr](\\.[Ii][Mm][Pp][Oo][Rr][Tt][Ss][Cc][Rr][Ii][Pp][Tt][Ss])?$"}]}}
tsconfig.json
moduleDetection
Specify how TypeScript determine a file as module.
{"enum": ["auto", "legacy", "force"]}
tsconfig.json
strictNullChecks
When type checking, take into account `null` and `undefined`.
{"type": "boolean", "default": false}
tsconfig.json
maxNodeModuleJsDepth
Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`.
{"type": "number", "default": 0}
tsconfig.json
importHelpers
Allow importing helper functions from tslib once per project, instead of including them per-file.
{"type": "boolean", "default": false}
tsconfig.json
importsNotUsedAsValues
Specify emit/checking behavior for imports that are only used for types.
{"default": "remove", "enum": ["remove", "preserve", "error"]}
tsconfig.json
alwaysStrict
Ensure 'use strict' is always emitted.
{"type": "boolean"}
tsconfig.json
strict
Enable all strict type checking options.
{"type": "boolean", "default": false}
tsconfig.json
strictBindCallApply
Check that the arguments for `bind`, `call`, and `apply` methods match the original function.
{"type": "boolean", "default": false}
tsconfig.json
downlevelIteration
Emit more compliant, but verbose and less performant JavaScript for iteration.
{"type": "boolean", "default": false}
tsconfig.json
checkJs
Enable error reporting in type-checked JavaScript files.
{"type": "boolean", "default": false}
tsconfig.json
strictFunctionTypes
When assigning functions, check to ensure parameters and the return values are subtype-compatible.
{"type": "boolean", "default": false}
tsconfig.json
strictPropertyInitialization
Check for class properties that are declared but not set in the constructor.
{"type": "boolean", "default": false}
tsconfig.json
esModuleInterop
Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility.
{"type": "boolean", "default": false}
tsconfig.json
allowUmdGlobalAccess
Allow accessing UMD globals from modules.
{"type": "boolean", "default": false}
tsconfig.json
keyofStringsOnly
Make keyof only return strings instead of string, numbers or symbols. Legacy option.
{"type": "boolean", "default": false}
tsconfig.json
useDefineForClassFields
Emit ECMAScript-standard-compliant class fields.
{"type": "boolean", "default": false}
tsconfig.json
declarationMap
Create sourcemaps for d.ts files.
{"type": "boolean", "default": false}
tsconfig.json
resolveJsonModule
Enable importing .json files
{"type": "boolean", "default": false}
tsconfig.json
resolvePackageJsonExports
Use the package.json 'exports' field when resolving package imports.
{"type": "boolean", "default": false}
tsconfig.json
resolvePackageJsonImports
Use the package.json 'imports' field when resolving imports.
{"type": "boolean", "default": false}
tsconfig.json
assumeChangesOnlyAffectDirectDependencies
Have recompiles in '--incremental' and '--watch' assume that changes within a file will only affect files directly depending on it. Requires TypeScript version 3.8 or later.
{"type": "boolean"}
tsconfig.json
extendedDiagnostics
Output more detailed compiler performance information after building.
{"type": "boolean", "default": false}
tsconfig.json
listFilesOnly
Print names of files that are part of the compilation and then stop processing.
{"type": "boolean"}
tsconfig.json
disableSourceOfProjectReferenceRedirect
Disable preferring source files instead of declaration files when referencing composite projects
{"type": "boolean"}
tsconfig.json
disableSolutionSearching
Opt a project out of multi-project reference checking when editing.
{"type": "boolean"}
tsconfig.json
verbatimModuleSyntax
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.
{"type": "boolean"}
tsconfig.json
typeAcquisition
Auto type (.d.ts) acquisition options for this project. Requires TypeScript version 2.1 or later.
{"type": "object", "properties": {"enable": {"type": "boolean", "default": false}, "include": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "exclude": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}}}
tsconfig.json
enable
Enable auto type acquisition
{"type": "boolean", "default": false}
tsconfig.json
include
Specifies a list of type declarations to be included in auto type acquisition. Ex. ["jquery", "lodash"]
{"type": "array", "uniqueItems": true, "items": {"type": "string"}}
tsconfig.json
exclude
Specifies a list of type declarations to be excluded from auto type acquisition. Ex. ["jquery", "lodash"]
{"type": "array", "uniqueItems": true, "items": {"type": "string"}}
tsconfig.json
references
Referenced projects. Requires TypeScript version 3.0 or later.
{"type": "array", "uniqueItems": true, "items": {"type": "object", "properties": {"path": {"type": "string"}}}}
tsconfig.json
items
Project reference.
{"type": "object", "properties": {"path": {"type": "string"}}}
tsconfig.json
path
Path to referenced tsconfig or to folder containing tsconfig.
{"type": "string"}
tsconfig.json
ts-node
ts-node options. See also: https://typestrong.org/ts-node/docs/configuration ts-node offers TypeScript execution and REPL for node.js, with source map support.
{"properties": {"compiler": {"default": "typescript", "type": "string"}, "compilerHost": {"default": false, "type": "boolean"}, "compilerOptions": {"additionalProperties": true, "allOf": [{}], "properties": {}, "type": "object"}, "emit": {"default": false, "type": "boolean"}, "esm": {"type": "boolean"}, "experimentalReplAwait": {"type": "boolean"}, "experimentalResolver": {"type": "boolean"}, "experimentalSpecifierResolution": {"enum": ["explicit", "node"], "type": "string"}, "files": {"default": false, "type": "boolean"}, "ignore": {"default": ["(?:^|/)node_modules/"], "items": {"type": "string"}, "type": "array"}, "ignoreDiagnostics": {"items": {"type": ["string", "number"]}, "type": "array"}, "logError": {"default": false, "type": "boolean"}, "moduleTypes": {}, "preferTsExts": {"default": false, "type": "boolean"}, "pretty": {"default": false, "type": "boolean"}, "require": {"items": {"type": "string"}, "type": "array"}, "scope": {"default": false, "type": "boolean"}, "scopeDir": {"default": "First of: `tsconfig.json` \"rootDir\" if specified, directory containing `tsconfig.json`, or cwd if no `tsconfig.json` is loaded.", "type": "string"}, "skipIgnore": {"default": false, "type": "boolean"}, "swc": {"type": "boolean"}, "transpileOnly": {"default": false, "type": "boolean"}, "transpiler": {"anyOf": [{"items": [{"type": "string"}, {"additionalProperties": true, "properties": {}, "type": "object"}], "maxItems": 2, "minItems": 2, "type": "array"}, {"type": "string"}]}, "typeCheck": {"default": true, "type": "boolean"}}, "type": "object"}
tsconfig.json
compiler
Specify a custom TypeScript compiler.
{"default": "typescript", "type": "string"}
tsconfig.json
compilerHost
Use TypeScript's compiler host API instead of the language service API.
{"default": false, "type": "boolean"}
tsconfig.json
compilerOptions
JSON object to merge with TypeScript `compilerOptions`.
{"additionalProperties": true, "allOf": [{}], "properties": {}, "type": "object"}
tsconfig.json
emit
Emit output files into `.ts-node` directory.
{"default": false, "type": "boolean"}
tsconfig.json
esm
Enable native ESM support. For details, see https://typestrong.org/ts-node/docs/imports#native-ecmascript-modules
{"type": "boolean"}
tsconfig.json
experimentalReplAwait
Allows the usage of top level await in REPL. Uses node's implementation which accomplishes this with an AST syntax transformation. Enabled by default when tsconfig target is es2018 or above. Set to false to disable. **Note**: setting to `true` when tsconfig target is too low will throw an Error. Leave as `undefined` to get default, automatic behavior.
{"type": "boolean"}
tsconfig.json
experimentalResolver
Enable experimental features that re-map imports and require calls to support: `baseUrl`, `paths`, `rootDirs`, `.js` to `.ts` file extension mappings, `outDir` to `rootDir` mappings for composite projects and monorepos. For details, see https://github.com/TypeStrong/ts-node/issues/1514
{"type": "boolean"}
tsconfig.json
experimentalSpecifierResolution
Like node's `--experimental-specifier-resolution`, , but can also be set in your `tsconfig.json` for convenience. For details, see https://nodejs.org/dist/latest-v18.x/docs/api/esm.html#customizing-esm-specifier-resolution-algorithm
{"enum": ["explicit", "node"], "type": "string"}