Nukem's Possible Manifestation

    @jest/create-cache-key-function
    TypeScript icon, indicating that this package has built-in type declarations

    29.1.0 • Public • Published

    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 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

    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),
    };

    Keywords

    none

    Install

    npm i @jest/create-cache-key-function

    DownloadsWeekly Downloads

    1,048,329

    Version

    29.1.0

    License

    MIT

    Unpacked Size

    6.25 kB

    Total Files

    5

    Last publish

    Collaborators

    • rubennorte
    • fb
    • aaronabramov
    • scotthovestadt
    • davidzilburg
    • simenb