Jest Ts Auto Mock


This is a library that extend ts-auto-mock to be used with jest

The intention of the library is to automatically assign jest mock to functions giving you type safety

Requirements

typescript@^3.2.2

ts-jest@>=24 <27

Installation

- A Transformer needs to be provided at compile time.
We need to tell ts-jest to use ttypescript that allow us to use a transformer.

$3

- set "cacheBetweenTests" as false
- Add the transformer to your ts config
``ts
{
"compilerOptions": {
...
"plugins": [
{ "transform": "ts-auto-mock/transformer", "cacheBetweenTests": false }
]
}
}
`

- Enable ttypescript into the ts-jest configuration
`ts
...
"globals": {
"ts-jest": {
"compiler": "ttypescript"
}
}
`

- provide jest-ts-auto-mock config before your test
`ts
"jest": {
...
"setupFiles": [
"/config.ts"
]
...
},
`

- config file
`ts
import 'jest-ts-auto-mock'

`

Examples

ts-jest-ttypesctipt

Usage

1) create an interface
`ts
interface Interface {
methodToMock: () => string
}
`
2) create a mock
`ts
const mock: Interface = createMock();
`
3) get the method mock

You can get the method spy in 2 different ways

Through method
`ts
import { On, method } from "ts-auto-mock/extension";
const mockMethod: Jest.Mock = On(mock).get(method(mock => mock.methodToMock));
`

Through string
`ts
import { On, method } from "ts-auto-mock/extension";
const mockMethod: Jest.Mock = On(mock).get(method('methodToMock'));
`
4) trigger the method
`ts
someMethodThatWillTriggerInterfaceA();
expect(mockMethod).toHaveBeenCalled();
``

Authors

* Vittorio Guerriero
* Giulio Caprino

License

This project is licensed under the MIT License