diff options
| author | Gerhard Stoebich <deb2001-github@yahoo.de> | 2018-04-10 10:21:56 +0200 |
|---|---|---|
| committer | Trivikram Kamat <16024985+trivikr@users.noreply.github.com> | 2018-04-11 21:38:41 -0700 |
| commit | 7ead832b5a134246e081ca0fe510d061abdd7829 (patch) | |
| tree | f92e63e4441488e48f02a439ef1d3a530eac9e02 /doc/api/vm.md | |
| parent | a3db1cc51403d70c2b15738ef9dedb103d1c08fe (diff) | |
| download | android-node-v8-7ead832b5a134246e081ca0fe510d061abdd7829.tar.gz android-node-v8-7ead832b5a134246e081ca0fe510d061abdd7829.tar.bz2 android-node-v8-7ead832b5a134246e081ca0fe510d061abdd7829.zip | |
doc: `vm.runIn*Context` can accept a string as options
PR-URL: https://github.com/nodejs/node/pull/19910
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Diffstat (limited to 'doc/api/vm.md')
| -rw-r--r-- | doc/api/vm.md | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/doc/api/vm.md b/doc/api/vm.md index 70702dd1cb..6c7bdeffda 100644 --- a/doc/api/vm.md +++ b/doc/api/vm.md @@ -694,7 +694,7 @@ Returns `true` if the given `sandbox` object has been [contextified][] using * `code` {string} The JavaScript code to compile and run. * `contextifiedSandbox` {Object} The [contextified][] object that will be used as the `global` when the `code` is compiled and run. -* `options` +* `options` {Object|string} * `filename` {string} Specifies the filename used in stack traces produced by this script. * `lineOffset` {number} Specifies the line number offset that is displayed @@ -713,6 +713,8 @@ the `contextifiedSandbox`, then returns the result. Running code does not have access to the local scope. The `contextifiedSandbox` object *must* have been previously [contextified][] using the [`vm.createContext()`][] method. +If `options` is a string, then it specifies the filename. + The following example compiles and executes different scripts using a single [contextified][] object: @@ -739,7 +741,7 @@ added: v0.3.1 * `code` {string} The JavaScript code to compile and run. * `sandbox` {Object} An object that will be [contextified][]. If `undefined`, a new object will be created. -* `options` +* `options` {Object|string} * `filename` {string} Specifies the filename used in stack traces produced by this script. * `lineOffset` {number} Specifies the line number offset that is displayed @@ -767,6 +769,8 @@ creates a new `sandbox` if passed as `undefined`), compiles the `code`, runs it within the context of the created context, then returns the result. Running code does not have access to the local scope. +If `options` is a string, then it specifies the filename. + The following example compiles and executes code that increments a global variable and sets a new one. These globals are contained in the `sandbox`. @@ -791,7 +795,7 @@ added: v0.3.1 --> * `code` {string} The JavaScript code to compile and run. -* `options` +* `options` {Object|string} * `filename` {string} Specifies the filename used in stack traces produced by this script. * `lineOffset` {number} Specifies the line number offset that is displayed @@ -809,6 +813,8 @@ added: v0.3.1 current `global` and returns the result. Running code does not have access to local scope, but does have access to the current `global` object. +If `options` is a string, then it specifies the filename. + The following example illustrates using both `vm.runInThisContext()` and the JavaScript [`eval()`][] function to run the same code: |