npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

delcache

v1.0.0

Published

delete module cache in node safely

Downloads

2

Readme

delcache

Delete module cache safely. This project is inspired by decache.

Build Status Coverage Status

Installation

# use npm
npm install delcache
# or use yarn
yarn global add delcache

Environment

Node.js 10+

Background

Deleting module cache is the precondition of 'hot reloading'. Typically, we delete the module cache by:

delete require.cache[require.resolve('xxx')]

However, this method can cause memory leakage. It clears the module cache in Module._cache which is referenced by require.cache, but it doesn't eliminate the reference in the array of xxx.parent.children.

delcache provides a way to eliminate both kinds of reference:

delcache('xxx')

In most cases, this is enough to clean up all references, with the following exception:

{
    id: 'parentModule',
    children: [{
        id: 'childModuleA',
        children: [{
            id: 'targetModule'
        }]
    }, {
        id: 'childModuleB',
        children: [{
            id: 'targetModule'
        }]
    }]
}

You will find targetModule still in the children of childModuleA after calling delcache(targetModule) in childModuleB. In this condition, you can pass true as the second argument to delcache: delcache(targetModule, true). delcache will traverse the whole module tree to delete targetModule from children of every module.

When passing rootPath as the third argument, delcache will take it as the starting point. It is a recommended way to save time traversing the module tree.

Usage

Delete cache of target module and clear reference in parent's children:

const delcache = require('delcache')

let five = require('./five')

five.num = 6

delcache('./five')

five = require('./five')

console.log(five.num) // 5

Pass true as the second argument to delete cache of target module from the whole module tree.

const delcache = require('delcache')

let five = require('./five')

five.num = 6

delcache('./five', true)

five = require('./five')

console.log(five.num) // 5

When the second argument is true, you can specify the rootPath from which clear the reference of the target module.

This is a recommended way to make the delete operation faster:

const delcache = require('delcache')

let five = require('./five')

five.num = 6

delcache('./five', true, '../../root')

five = require('./five')

console.log(five.num) // 5

Notice

Don't uese delete require.cache[xxx] with delcache, cause delcache will check if a module is referenced by Module._cache.

//parent.js
require('./a')
require('./b')
//a.js
require('./mod')
delete require.cache[require.resolve('./mod')]
//b.js
const delcache = require('delcahce')
delcache('./mod', true) // delcache can not eliminate the reference of mod in children of a.js