clear-module

clear-module

Clear a module from the cache

Useful for testing purposes when you need to freshly import a module.

Install

$ npm install clear-module

Usage

// foo.js
let i = 0;
module.exports = () => ++i;

const clearModule = require('clear-module');

require('./foo')();
//=> 1

require('./foo')();
//=> 2

clearModule('./foo');

require('./foo')();
//=> 1

API

clearModule(moduleId)

moduleId

Type: string

What you would use with require().

clearModule.all()

Clear all modules from the cache.

clearModule.match(regex)

Clear all matching modules from the cache.

regex

Type: RegExp

Regex to match against the module IDs.

clearModule.single(moduleId)

Clear a single module from the cache non-recursively. No parent or children modules will be affected.

This is mostly only useful if you use singletons, where you would want to clear a specific module without causing any side effects.

moduleId

Type: string

What you would use with require().

Related

• import-fresh - Import a module while bypassing the cache
• import-from - Import a module from a given path
• import-cwd - Import a module from the current working directory
• import-lazy - Import a module lazily

Similar packages

Other packages similar to clear-module

decache

The decache package provides similar functionality by allowing you to remove a module from the require cache. It is straightforward to use and offers a simple API for clearing modules. Compared to clear-module, decache is more focused on single module clearing and does not provide built-in support for clearing multiple or all modules.

require-reload

The require-reload package allows you to require a module and always get a fresh instance of it. Unlike clear-module, which clears the cache and then requires the module, require-reload handles the re-requiring internally, making it a bit more convenient for certain use cases.

proxyquire

Proxyquire is a more advanced tool that allows you to mock dependencies when requiring modules. While it can be used to achieve similar results to clear-module by mocking and re-requiring modules, it is more complex and offers a broader range of functionalities, including dependency injection and mocking.