You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
![]() |
2 years ago | |
---|---|---|
.. | ||
build | 2 years ago | |
node_modules | 2 years ago | |
.eslintcache | 2 years ago | |
LICENSE | 2 years ago | |
README.md | 2 years ago | |
package.json | 2 years ago |
README.md
jest-create-cache-key-function
This module creates a function which is used for generating cache keys used by code transformers in Jest.
Install
$ 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 keyvalues
: [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
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),
};