A sandboxed node.js module loader that lets you inject dependencies into your modules.
npm install sandboxed-module
var SandboxedModule = require('sandboxed-module');
var user = SandboxedModule.require('./user', {
requires: {'mysql': {fake: 'mysql module'}},
globals: {myGlobal: 'variable'},
locals: {myLocal: 'other variable'},
});
This module is intended to ease dependency injection for unit testing. However, feel free to use it for whatever crimes you can think of.
Returns a new SandboxedModule
where moduleId
is a regular module path / id
as you would normally pass into require()
. The new module will be loaded in
its own v8 context, but otherwise have access to the normal node.js
environment.
options
is an optional object that can be used to inject any of the
following:
requires:
An object containingmoduleId
s and the values to inject for them when required by the sandboxed module. This does not affect children of the sandboxed module.globals:
An object of global variables to inject into the sandboxed module.locals:
An object of local variables to inject into the sandboxed module.
Identical to SandboxedModule.load()
, but returns sandboxedModule.exports
directly.
The full path to the module.
The underlaying node.js Module
instance.
A getter returning the sandboxedModule.module.exports
object.
The global object of the v8 context this module was loaded in. Modifications to this object will be reflected in the sandboxed module.
The local variables injected into the sandboxed module using a closure. Modifying this object has no effect on the state of the sandbox.
An object holding a list of all module required by the sandboxed module itself.
The keys are the moduleId
s used for the require calls.
sandboxed-module is licensed under the MIT license.