Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    cache-walkpublic

    Build Status downloads npm Code Climate Test Coverage dependencies

    cache-walk

    Walk a require tree for a cached module.

    Installation

    npm install --save cache-walk

    Summary

    Requiring one file typically adds more than one file to the require cache, since that file (probably) requires other files, which potentially require other files. This module let's you walk through the entire require tree of a particular module as it is in the cache.

    Usage

    cache-walk exports three functions for interacting with a require tree: .get, .walk, and .delete. .get returns a list of module ids (absolute file paths), .walk calls a function for each module encountered, and .delete deletes an entire require tree from the cache.

    .get

    var foo = require('./foo');
    var cache = require('cache-walk');
     
    // requiredModules will contain ./foo
    // plus everything required by ./foo and it's children
    var requiredModules = cache.get('./foo');

    .walk

    var foo = require('./foo');
    var cache = require('cache-walk');
     
    // The callback will be called first with the ./foo module id
    // and then with everything required by ./foo and it's children
    cache.walk('./foo', function(mod) {
      console.log(mod);
    });

    .delete

    var foo = require('./foo');
    var cache = require('cache-walk');
     
    // Delete ./foo from the cache along with it's children etc.
    cache.delete('./foo');

    These examples use relative paths, but absolute ones work as well.

    Contributing

    Please see the contribution guidelines.

    install

    npm i cache-walk

    Downloadsweekly downloads

    6

    version

    1.0.2

    license

    MIT

    repository

    githubgithub

    last publish

    collaborators

    • avatar