Skip to content

Require a module and receive a callback with an up-to-date one each time is modified

License

Notifications You must be signed in to change notification settings

Llorx/updated-require

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Updated Require

npm npm

This module will keep track of modules and any of his dependencies changes, and will always return an up-to-date module.

To receive a callback for any non-native dependecies an specific module loads, see https://github.com/Llorx/custom-require

To check for module and dependencies modifications without reloading, see https://github.com/Llorx/watcher-require

Installation

npm install updated-require

If you want a lightweight installation, but less consistent as uses nodejs fs.watch() instead of chokidar library, install with:

npm install updated-require --no-optional

Usage

/* FILE: test1.js */
module.exports = {
    test2: require("./test2"),
    message: "I'm test1.js"
};
/* FILE: test2.js */
module.exports = "I'm test2.js!";
/* FILE: main.js */
// Load the module at the top of the entry point file
var UpdatedRequire = require("updated-require").UpdatedRequire;

// If you are using TypeScript, you can use import
import { UpdatedRequire } from "updated-require";

// Instantiate an object. You can add an optional callback.
// Only use the old instance to validate data. Do not keep the reference.
var updatedRequire = new UpdatedRequire(function(oldmodule, newmodule) {
    // This callback will be called only when a valid module is created
    console.log("Old module changed!", oldmodule.filename, newmodule.filename);
});

// Require a module and see how returns a different output each time you modify it.
var interval = setInterval(function() {
    // If the module is half-written, instead of returning an error, will return and old cached module.
    // Try to add syntax error code to the files, and see how it returns old exports until errors are fixed.
    console.log(updatedRequire.require("./test1"));
}, 1000);

// After you have finished, call dispose() to clean resources attached to modules
setTimeout(function() {
    clearInterval(interval);
    updatedRequire.dispose();
}, 30000);

Limitations

See Custom Require limitations: https://github.com/Llorx/custom-require#limitations

About

Require a module and receive a callback with an up-to-date one each time is modified

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published