Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A sandboxed node.js module loader that lets you inject dependencies into your modules.
JavaScript
branch: master

This branch is 1 commit ahead, 54 commits behind felixge:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
test
.gitignore
.travis.yml
License
Makefile
Readme.md
package.json

Readme.md

sandboxed-module

Build Status

A sandboxed node.js module loader that lets you inject dependencies into your modules.

Installation

npm install sandboxed-module

Usage

var SandboxedModule = require('sandboxed-module');
var user = SandboxedModule.require('./user', {
  requires: {'mysql': {fake: 'mysql module'}},
  globals: {myGlobal: 'variable'},
  locals: {myLocal: 'other variable'},
});

What to do with this

This module is intended to ease dependency injection for unit testing. However, feel free to use it for whatever crimes you can think of.

API

SandboxedModule.load(moduleId, [options])

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 containing moduleIds 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.

SandboxedModule.require(moduleId, [options])

Identical to SandboxedModule.load(), but returns sandboxedModule.exports directly.

sandboxedModule.filename

The full path to the module.

sandboxedModule.module

The underlaying node.js Module instance.

sandboxedModule.exports

A getter returning the sandboxedModule.module.exports object.

sandboxedModule.globals

The global object of the v8 context this module was loaded in. Modifications to this object will be reflected in the sandboxed module.

sandboxedModule.locals

The local variables injected into the sandboxed module using a closure. Modifying this object has no effect on the state of the sandbox.

sandboxedModule.required

An object holding a list of all module required by the sandboxed module itself. The keys are the moduleIds used for the require calls.

sandboxedModule.getGlobalLeaks()

Returns an array of variable names that have leaked into the global scope, except those those that are part of the node environment, or have been injected using the globals: option.

License

sandboxed-module is licensed under the MIT license.

Something went wrong with that request. Please try again.