function-sandbox

KO | EN

gitlite — search

#javascript #python #react #typescript #go #machine-learning #linux #nodejs #java #cli #kubernetes #ios #openai #open-source

function-sandbox

(★ 8)

📦 Make a "sandbox" for a function.

function-sandbox 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# function-sandbox <a href="https://www.npmjs.com/package/function-sandbox"><img src="https://img.shields.io/npm/v/function-sandbox.svg"></a>

📦 Make a sandbox for a function, **isolating the function's effects**, **blocking outer-scoped variables** (e.g. `window`, `global`) **and dangerious operations** (e.g. `eval()`, `new Function()`).

All the module exports is a main function.

## Input/Output

### input (parameter)

A function or string of a function.

### output (return)

A function or string of a function.

## Installation

```bash
$ npm install --save function-sandbox
```

## Usage

### example

```js
const fnsb = require('function-sandbox');

let a = 1;

let f1 = function (b) {
    console.log(a = b + 1);
//              ^
    console.log(c);
//              ^
    function f() {
        console.log(d);
        console.log(e);
//                  ^
        console.log(window);
//                  ^
        console.log(global);
//                  ^
        eval('console.log("using eval()")');
//      ^
        (new Function('console.log("using new Function()")'))();
//           ^
    }
    var F = f.constructor;
    (new F('console.log("using new Function()")'))();
//       ^
    var d = 1;
    return f();
};

let f2 = fnsb(f1, true);    // `f2` is function
f2(1);                      // => 2 undefined 1 undefined {} {}
console.log(a);             // => 1

let f3 = fnsb(f1);          // `f3` is string
```

Now `f3` is such a **string** of a function:

```
"function () { var window = {}, global = {}, process = {}, Function = function () { return function () {} }, eval = function () {}; return (function (b) {
    'use strict';
    var a, c, e;
    ... Here is the original function body ...
}).apply(null, arguments); }"
```

### options

The second parameter is optional and can be either Boolean or Object. When it is `true`, the main function will return a function instead of a string. When it is an object, it has several properties to be set:

| property | value | example |
| :---: | :--- | :---: |
| asFunction | Boolean, whether to return a function or a string. | `true` |
| whiteList | Array, a list of variable names not to be blocked. | `['$']` `['Promise', 'JSON']` |
| injection | Object, a map from variable name to value. | `{ a: 1, b: function (x) { return x * x; } }` |

## More Related

* The [Function](http://www.ecma-international.org/ecma-262/5.1/#sec-15.3.2) in JavaScript.
* Node.js [vm](https://nodejs.org/api/vm.html).
* [Web Worker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API).

## License

[MIT](http://opensource.org/licenses/MIT)

function-sandbox

function-sandbox 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

function-sandbox

function-sandbox 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README