id | title |
---|---|
options |
Options |
All ts-jest
specific options can be defined in Jest transform
config object in the package.json
file of your project,
or through a jest.config.js
, or jest.config.ts
file.
// package.json
{
// [...]
"jest": {
"transform": {
"<regex_match_files>": [
"ts-jest",
{
// ts-jest configuration goes here
}
]
}
}
}
Or through JavaScript:
// jest.config.js
module.exports = {
// [...]
transform: {
'<regex_match_files>': [
'ts-jest',
{
// ts-jest configuration goes here
},
],
},
}
:::tip
To utilize IDE suggestions, you can use JSDoc
comments to provide suggested ts-jest
configs for your Jest config:
/** @type {import('ts-jest').JestConfigWithTsJest} */
module.exports = config = {
// [...]
transform: {
'<regex_match_files>': [
'ts-jest',
{
// ts-jest configuration goes here and your IDE will suggest which configs when typing
},
],
},
}
:::
Or through TypeScript (if ts-node
is installed):
// jest.config.ts
import type { JestConfigWithTsJest } from 'ts-jest'
const config: JestConfigWithTsJest = {
transform: {
'<regex_match_files>': [
'ts-jest',
{
// ts-jest configuration goes here
},
],
},
}
export default config
:::important
When using TypeScript Jest config file, Jest will use ts-node
to compile the config file. ts-jest
doesn't take part in
that process.
:::
All options have default values which should fit most of the projects. Click on the option's name to see details and example(s).
Option | Description | Type | Default |
---|---|---|---|
compiler |
TypeScript module to use as compiler. | string |
"typescript" |
tsconfig |
TypeScript compiler related configuration. | string |object |boolean |
auto |
isolatedModules |
Disable type-checking | boolean |
disabled |
astTransformers |
Custom TypeScript AST transformers | object |
auto |
diagnostics |
Diagnostics related configuration. | boolean |object |
enabled |
babelConfig |
Babel(Jest) related configuration. | boolean |string |object |
disabled |
stringifyContentPathRegex |
Files which will become modules returning self content. | string |RegExp |
disabled |
useESM |
Enable ESM support | boolean |
auto |