Specify a custom TypeScript compiler.
Use TypeScript's compiler host API instead of the language service API.
JSON object to merge with TypeScript compilerOptions
.
Emit output files into .ts-node
directory.
Load "files" and "include" from tsconfig.json
on startup.
Default is to override tsconfig.json
"files" and "include" to only include the entrypoint script.
Paths which should not be compiled.
Each string in the array is converted to a regular expression via new RegExp()
and tested against source paths prior to compilation.
Source paths are normalized to posix-style separators, relative to the directory containing tsconfig.json
or to cwd if no tsconfig.json
is loaded.
Default is to ignore all node_modules subdirectories.
Ignore TypeScript warnings by diagnostic code.
Logs TypeScript errors to stderr instead of throwing exceptions.
Override certain paths to be compiled and executed as CommonJS or ECMAScript modules. When overridden, the tsconfig "module" and package.json "type" fields are overridden. This is useful because TypeScript files cannot use the .cjs nor .mjs file extensions; it achieves the same effect.
Each key is a glob pattern following the same rules as tsconfig's "include" array. When multiple patterns match the same file, the last pattern takes precedence.
cjs
overrides matches files to compile and execute as CommonJS.
esm
overrides matches files to compile and execute as native ECMAScript modules.
package
overrides either of the above to default behavior, which obeys package.json "type" and
tsconfig.json "module" options.
Re-order file extensions so that TypeScript imports are preferred.
For example, when both index.js
and index.ts
exist, enabling this option causes require('./index')
to resolve to index.ts
instead of index.js
Use pretty diagnostic formatter.
Modules to require, like node's --require
flag.
If specified in tsconfig.json
, the modules will be resolved relative to the tsconfig.json
file.
If specified programmatically, each input string should be pre-resolved to an absolute path for best results.
Scope compiler to files within scopeDir
.
Skip ignore check, so that compilation will be attempted for all files with matching extensions.
Use TypeScript's faster transpileModule
.
Specify a custom transpiler for use with transpileOnly
DEPRECATED Specify type-check is enabled (e.g. transpileOnly == false
).
Generated using TypeDoc
Must be an interface to support
typescript-json-schema
.