rddx-mod

module loader for REPL drive development

Installation

Only for Node v4.0.0 or above:

$ npm install rddx-mod --save

Usage

'use strict';

const Mod = require('rddx-mod');

let mod = Mod({
  path: __dirname,   // module files base path
  reload: true,      // set to true to auto reload module when it has been changed. default to false
  delay: 100,        // when module has been changed, auto reload it after a while. default to 100ms
});

// register modules
// mod.register('name', 'path to');
mod.register('a', './a');
mod.register('b', './b');
// register third-part package
// mod.register('name', 'package');
mod.register('express', 'express');
// specified dependencies, after one of the dependencies has been reloaded, will reload this module automatically
mod.register('c', './c', {dependencies: ['a', 'b']});

// unregister module, and remove cache
mod.unregister('a');

// reload module although it has not changed
mod.reload('a');

// use module
// get property
mod('a').name;
mod('a', 'name');     // will throws error if "name" does not exists
mod.get('a', 'name'); // will throws error if "name" does not exists
// call method
mod('a').hello(msg);
mod('a', 'hello')(msg);      // will throws error if "hello" does not exists or is not a function
mod('a').get('hello')(msg);  // will throws error if "hello" does not exists or is not a function
mod.call('a', 'hello', msg); // will throws error if "hello" is not a function

const hello = mod.bind('a', 'hello');
hello(msg);

// emit "reload" event when module has been reloaded
mod.on('reload', function (name, file) {
  // name: registered name
  // file: absolute file path
});

// emit "register" event when module has been registered
mod.on('register', function (name, file, pkg) {
  // name: registered name
  // file: absolute file path (if your register a package, this is the "package.json" file of the registered package)
  // pkg:  package name (if your are not register a package, pkg is null)
});

// emit "unregister" event when module has been unregistered
mod.on('unregister', function (name, data) {
  // name: registered name
  // data: cache data
});

// if you want to catch the event of specified module,
// listen "eventName moduleName" event,
// for example:
mod.on('reload a', function (name, file) {
  // when module "a" has been reloaded, will emit this event
});

mod.on('destroy', function () {
  console.log('has been destroyed');
});

// all of above events has the "before eventName" event
// for example:
mod.on('before reload a', function (name, file) {
  // before "reload a" event emit, will emit this event
});

// unwatch all files and destroy mod instance
mod.destroy();

License

The MIT License (MIT)

Copyright (c) 2015 Zongmin Lei <[email protected]>
http://ucdok.com

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.