Code Monkey home page Code Monkey logo

islo's Introduction

N|Solid

Islo ๐Ÿšง

Require modules in a sandbox environment. Modules are unable to require blacklisted modules and/or files outside of its root. Islo does not require any dependencies.

Installation

Using npm:

$ npm I --save islo

Example

const Islo = require('islo')
const box = new Islo('./module', {
  blacklist: ['fs', 'mysql']
})

box.on('error', function (error) {
  console.log(error.toString())
})

box.run()

const box = new Islo(pathToModule, options)

  • pathToModule (String)
  • options (Object)
    • key (String) Path to the root folder of the given module. By default is the file directory of the module used.
    • blacklist (Array) If the module tries to require one of the blacklisted modules will an error be thrown.
    • middleware (Object) See the documentation about middleware for more information.
  • Returns Box

Create a new sandbox environment for the given module. By default is the module allowed to require any module but not any path outside of its root.

box.on(eventName, callback)

  • eventName (String)
  • callback (Function)

Register a new handler for the given event. The callback function is called when the event is fired.


Middleware

key arguments description
isSafe module, info This function is called when validating if a module is safe. Two arguments are passed the path/name of the module and some basic info. This function should return true if a module is safe and false if otherwise. If nothing is returned will the function be ignored.
require none This function is called when requiring a module. This function can return a custom variable/module. If a module should be wrapped inside of a sandbox could the 'wrap' method inside the scope be used. If nothing is returned is the function ignored.

Events

event description
error A fatal error has occurred when trying to execute the module. This can be caused because the module tried to require a blacklisted or unsafe module.

islo's People

Contributors

jeroenrinzema avatar oxyxo avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

oxyxo

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.