diff options
author | Nick Schonning <nschonni@gmail.com> | 2019-10-10 01:49:08 +0300 |
---|---|---|
committer | Rich Trott <rtrott@gmail.com> | 2019-10-11 08:15:58 +0300 |
commit | 81bc7b3ba5a37a5ad4de0f8798eb42e631d55617 (patch) | |
tree | 151d163358f029f8f686b595db2c565ddcff1070 /doc/api/vm.md | |
parent | a1e47d7603b1d0bf54c8aad027298e964b8c8af4 (diff) |
doc: escape brackets not used as markdown reference links
These can turn into links if reference links are added to the document
PR-URL: https://github.com/nodejs/node/pull/29809
Reviewed-By: Rich Trott <rtrott@gmail.com>
Diffstat (limited to 'doc/api/vm.md')
-rw-r--r-- | doc/api/vm.md | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/doc/api/vm.md b/doc/api/vm.md index 601b8c30520..cc244f66940 100644 --- a/doc/api/vm.md +++ b/doc/api/vm.md @@ -51,7 +51,7 @@ added: v0.3.1 Instances of the `vm.Script` class contain precompiled scripts that can be executed in specific sandboxes (or "contexts"). -### Constructor: new vm.Script(code[, options]) +### Constructor: new vm.Script(code\[, options\]) <!-- YAML added: v0.3.1 changes: @@ -130,7 +130,7 @@ script.runInThisContext(); const cacheWithX = script.createCachedData(); ``` -### script.runInContext(contextifiedSandbox[, options]) +### script.runInContext(contextifiedSandbox\[, options\]) <!-- YAML added: v0.3.1 changes: @@ -188,7 +188,7 @@ Using the `timeout` or `breakOnSigint` options will result in new event loops and corresponding threads being started, which have a non-zero performance overhead. -### script.runInNewContext([sandbox[, options]]) +### script.runInNewContext(\[sandbox\[, options\]\]) <!-- YAML added: v0.3.1 changes: @@ -255,7 +255,7 @@ console.log(util.inspect(sandboxes)); // [{ globalVar: 'set' }, { globalVar: 'set' }, { globalVar: 'set' }] ``` -### script.runInThisContext([options]) +### script.runInThisContext(\[options\]) <!-- YAML added: v0.3.1 changes: @@ -404,7 +404,7 @@ const contextifiedSandbox = vm.createContext({ secret: 42 }); })(); ``` -### Constructor: new vm.SourceTextModule(code[, options]) +### Constructor: new vm.SourceTextModule(code\[, options\]) * `code` {string} JavaScript Module code to parse * `options` @@ -492,7 +492,7 @@ exception due to possible ambiguity with `throw undefined;`. Corresponds to the `[[EvaluationError]]` field of [Source Text Module Record][]s in the ECMAScript specification. -### module.evaluate([options]) +### module.evaluate(\[options\]) * `options` {Object} * `timeout` {integer} Specifies the number of milliseconds to evaluate @@ -613,7 +613,7 @@ value that is not `undefined`. The identifier of the current module, as set in the constructor. -## vm.compileFunction(code[, params[, options]]) +## vm.compileFunction(code\[, params\[, options\]\]) <!-- YAML added: v10.10.0 --> @@ -644,7 +644,7 @@ Compiles the given code into the provided context/sandbox (if no context is supplied, the current context is used), and returns it wrapped inside a function with the given `params`. -## vm.createContext([sandbox[, options]]) +## vm.createContext(\[sandbox\[, options\]\]) <!-- YAML added: v0.3.1 changes: @@ -722,7 +722,7 @@ added: v0.11.7 Returns `true` if the given `sandbox` object has been [contextified][] using [`vm.createContext()`][]. -## vm.runInContext(code, contextifiedSandbox[, options]) +## vm.runInContext(code, contextifiedSandbox\[, options\]) <!-- YAML added: v0.3.1 changes: @@ -802,7 +802,7 @@ console.log(util.inspect(sandbox)); // { globalVar: 1024 } ``` -## vm.runInNewContext(code[, sandbox[, options]]) +## vm.runInNewContext(code\[, sandbox\[, options\]\]) <!-- YAML added: v0.3.1 changes: @@ -900,7 +900,7 @@ console.log(util.inspect(sandbox)); // { animal: 'cat', count: 3, name: 'kitty' } ``` -## vm.runInThisContext(code[, options]) +## vm.runInThisContext(code\[, options\]) <!-- YAML added: v0.3.1 changes: |