live-modules

0.1.2 • Public • Published

live-modules

Node modules can automatically update themselves while app is running if modules are edited. No need to restart the app every time!

Why Live Modules?

live modules allow you to make changes to a module while your app is running.

To install Live Modules:

npm install live-modules

Documentation:

var lm = require('live-modules').createLiveModules(require);

lm.require(mod, vrr, [callback]);

mod:
    type: string
    holds: module name or filename

vrr:
    type: string
    holds: global variable to assign module to

callback:
    gives: err, vrr, mod, status as args
        err: error  [Error]
        vrr: name of global variable  string
        mod: module name or filename  string
        status: the status of modules loading  string  {loaded|updated|update_failed}

Example module:

module.exports = {
  name: 'myModule',
  func: function () {
    /* does stuff */
  }
};

Example app:

var lm = require('live-modules').createLiveModules(require);

lm.require('myModule','myVar', function (err, vrr, mod, status) {
    console.log(status);
    if (err) {
        console.log(err);
    } else {
        /* do stuff with module */
        console.log(myVar.name); // or console.log(global[vrr].name);
        myVar.func(); // or global[vrr].func();
    }
});

Created By:

Michaelangelo Jong

Readme

Keywords

none

Package Sidebar

Install

npm i live-modules

Weekly Downloads

0

Version

0.1.2

License

BSD-2-Clause

Last publish

Collaborators

  • mike96angelo