-
-
Notifications
You must be signed in to change notification settings - Fork 6.5k
/
README.md
45 lines (29 loc) · 1.37 KB
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
# jest-create-cache-key-function
This module creates a function which is used for generating cache keys used by code transformers in Jest.
## Install
```sh
$ npm install --save-dev @jest/create-cache-key-function
```
## API
### `createCacheKey(files?: Array<string>, values?: Array<String>): GetCacheKeyFunction`
Get a function that can generate cache keys using source code, provided files and provided values.
#### Parameters
- `files`: [Optional] Array of absolute paths to files whose code should be accounted for when generating cache key
- `values`: [Optional] Array of string values that should be accounted for when generating cache key
**Note:**
The source code for your test is already taken into account when generating the cache key. The `files` array should be used to provide files that are not directly related to your code such as external configuration files.
## Usage
Here is some sample usage code while creating a new transformer for Jest
```javascript
const createCacheKeyFunction =
require('@jest/create-cache-key-function').default;
const filesToAccountFor = [
__filename,
require.resolve('some-package-name/package.json'),
];
const valuesToAccountFor = [process.env.SOME_LOCAL_ENV, 'Some_Other_Value'];
module.exports = {
process(src, filename, config, options) {},
getCacheKey: createCacheKeyFunction(filesToAccountFor, valuesToAccountFor),
};
```