add options object

Author: hacksparrow

README.md

@@ -1,4 +1,4 @@
-# safe-eval
+# safe-eval [![npm version](https://badge.fury.io/js/safe-eval.svg)](https://badge.fury.io/js/safe-eval)
 
 ## What is this?
 
@@ -18,45 +18,47 @@ npm install safe-eval --save
 var safeEval = require('safe-eval')
 ```
 
-**safeEval(code, [context])**
+**safeEval(code, [context], options)**
 
 `code` is the JavaScript code you want to execute.
 
 `context` is an object of methods and properties, these methods and properties are interpreted as global objects in `code`. Be careful about the objects you are passing to the context API, because they can completely defeat the purpose of `safe-eval`.
 
+`options` is the [options object](https://nodejs.org/api/vm.html) for the vm executing the code.
+
 ### Examples
 
-```
+```js
 // string concatenation
 var code = '"app" + "le"'
 var evaluated = safeEval(code) // "apple"
 ```
 
-```
+```js
 // math
 var code = 'Math.floor(22/7)'
 var evaluated = safeEval(code) // 3.142857142857143
 ```
 
-```
+```js
 // JSON
 var code = '{name: "Borat", hobbies: ["disco dance", "sunbathing"]}'
 var evaluated = safeEval(code) // {name: "Borat", hobbies: ["disco dance", "sunbathing"]}
 ```
 
-```
+```js
 // function expression
 var code = '(function square(b) { return b * b; })(5)'
 var evaluated = safeEval(code) // 25
 ```
 
-```
+```js
 // no access to Node.js objects
 var code = 'process'
 safeEval(code) // THROWS!
 ```
 
-```
+```js
 // your own context API - access to Node's process object and a custom function
 var code = '{pid: process.pid, apple: a()}'
 var context = {
@@ -66,9 +68,15 @@ var context = {
 var evaluated = safeEval(code, context) // { pid: 16987, apple: 'APPLE' }
 ```
 
+```js
+// pass an options object to the vm
+var code = 'process'
+safeEval(code, {}, { filename: 'myfile.js'}) // myfile.js can be seen in the stacktrace
+```
+
 ## License (MIT)
 
-Copyright (c) 2015 Hage Yaapa
+Copyright (c) 2016 Hage Yaapa
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package.json

@@ -1,6 +1,6 @@
 {
   "name": "safe-eval",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Safer version of eval()",
   "main": "index.js",
   "scripts": {

test/test.js

@@ -4,7 +4,6 @@ var assert = require('assert')
 var safeEval = require(__dirname + '/..')
 
 describe('safe-eval', function () {
-
   it('should perform string concatenation', function () {
     var code = '"app" + "le"'
     var evaluated = safeEval(code)
@@ -55,4 +54,12 @@ describe('safe-eval', function () {
     assert(evaluated.apple === 'APPLE')
   })
 
+  it('should include vm options', function () {
+    var code = 'foo'
+    try {
+      safeEval(code, {}, { filename: 'bar.js', timeout: 1 })
+    } catch (e) {
+      assert(e.stack.indexOf('bar.js') > 0)
+    }
+  })
 })