Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: allow <code> in header elements #31086

Merged
merged 44 commits into from
Dec 27, 2019
Merged
Changes from 1 commit
Commits
Show all changes
44 commits
Select commit Hold shift + click to select a range
fdec6bd
doc: allow <code> in header elements
Trott Dec 23, 2019
5998523
doc,dns: use code markup/markdown in headers
Trott Dec 23, 2019
d0f9585
doc: use code markup/markdown in headers in addons documentation
Trott Dec 23, 2019
b5834a4
doc,assert: use code markup/markdown in headers
Trott Dec 23, 2019
a5eb139
doc,async_hooks: use code markup/markdown in headers
Trott Dec 23, 2019
5847a4d
doc,buffer: use code markup/markdown in headers
Trott Dec 23, 2019
19419a4
doc,child_process: use code markup/markdown in headers
Trott Dec 23, 2019
4459988
doc,cluster: use code markup/markdown in headers
Trott Dec 24, 2019
adc9fa2
doc,console: use code markup/markdown in headers
Trott Dec 24, 2019
f6b6701
doc,crypto: use code markup/markdown in headers
Trott Dec 24, 2019
8e7d61e
doc: use code markup/markdown in headers in deprecations documentation
Trott Dec 24, 2019
0c8ff7c
doc,dgram: use code markup/markdown in headers
Trott Dec 24, 2019
75ab328
doc,domain: use code markup/markdown in headers
Trott Dec 24, 2019
57f7537
doc,errors: use code markup/markdown in headers
Trott Dec 24, 2019
b3ff048
doc,esm: use code markup/markdown in headers
Trott Dec 24, 2019
36edbde
doc,events: use code markup/markdown in headers
Trott Dec 24, 2019
b407503
doc,fs: use code markup/markdown in headers
Trott Dec 24, 2019
6f5e765
doc: use code markup/markdown in headers in globals documentation
Trott Dec 24, 2019
f8795db
doc,http: use code markup/markdown in headers
Trott Dec 24, 2019
2d6949d
doc,http2: use code markup/markdown in headers
Trott Dec 24, 2019
fe4a7a2
doc,https: use code markup/markdown in headers
Trott Dec 24, 2019
fc94934
doc,inspector: use code markup/markdown in headers
Trott Dec 24, 2019
248f057
doc,module: use code markup/markdown in headers
Trott Dec 24, 2019
933fd9b
doc,net: use code markup/markdown in headers
Trott Dec 24, 2019
24f24d9
doc,os: use code markup/markdown in headers
Trott Dec 24, 2019
a70c3ab
doc,path: use code markup/markdown in headers
Trott Dec 24, 2019
c956cab
doc,perf_hooks: use code markup/markdown in headers
Trott Dec 24, 2019
fc0aa3f
doc,process: use code markup/markdown in headers
Trott Dec 24, 2019
1c33523
doc,punycode: use code markup/markdown in headers
Trott Dec 24, 2019
d592efe
doc,querystring: use code markup/markdown in headers
Trott Dec 24, 2019
8b89c89
doc,readline: use code markup/markdown in headers
Trott Dec 24, 2019
85aed3e
doc,repl: use code markup/markdown in headers
Trott Dec 24, 2019
7034a3e
doc,stream: use code markup/markdown in headers
Trott Dec 24, 2019
cdb727d
doc,string_decoder: use code markup/markdown in headers
Trott Dec 24, 2019
7bb1f47
doc,timers: use code markup/markdown in headers
Trott Dec 24, 2019
e11b327
doc,tls: use code markup/markdown in headers
Trott Dec 24, 2019
a80d4ac
doc,tty: use code markup/markdown in headers
Trott Dec 24, 2019
79f6412
doc,url: use code markup/markdown in headers
Trott Dec 24, 2019
d9004da
doc,zlib: use code markup/markdown in headers
Trott Dec 24, 2019
ff6e7a0
doc,util: use code markup/markdown in headers
Trott Dec 24, 2019
ae4cd76
doc,v8: use code markup/markdown in headers
Trott Dec 24, 2019
deb0c81
doc,worker: use code markup/markdown in headers
Trott Dec 24, 2019
257a5dd
doc,vm: use code markup/markdown in headers
Trott Dec 25, 2019
b46efa9
doc,wasi: use code markup/markdown in headers
Trott Dec 25, 2019
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
doc,vm: use code markup/markdown in headers
PR-URL: #31086
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
  • Loading branch information
Trott committed Dec 27, 2019
commit 257a5dd46d1c11787264e8d2c419d6ad5c056b55
52 changes: 26 additions & 26 deletions doc/api/vm.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,15 @@ console.log(context.y); // 17
console.log(x); // 1; y is not defined.
```

## Class: vm.Script
## Class: `vm.Script`
<!-- YAML
added: v0.3.1
-->

Instances of the `vm.Script` class contain precompiled scripts that can be
executed in specific contexts.

### Constructor: new vm.Script(code\[, options\])
### Constructor: `new vm.Script(code[, options])`
<!-- YAML
added: v0.3.1
changes:
Expand Down Expand Up @@ -99,7 +99,7 @@ Creating a new `vm.Script` object compiles `code` but does not run it. The
compiled `vm.Script` can be run later multiple times. The `code` is not bound to
any global object; rather, it is bound before each run, just for that run.

### script.createCachedData()
### `script.createCachedData()`
<!-- YAML
added: v10.6.0
-->
Expand All @@ -126,7 +126,7 @@ script.runInThisContext();
const cacheWithX = script.createCachedData();
```

### script.runInContext(contextifiedObject\[, options\])
### `script.runInContext(contextifiedObject[, options])`
<!-- YAML
added: v0.3.1
changes:
Expand Down Expand Up @@ -184,7 +184,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(\[contextObject\[, options\]\])
### `script.runInNewContext([contextObject[, options]])`
<!-- YAML
added: v0.3.1
changes:
Expand Down Expand Up @@ -251,7 +251,7 @@ console.log(util.inspect(contexts));
// [{ globalVar: 'set' }, { globalVar: 'set' }, { globalVar: 'set' }]
```

### script.runInThisContext(\[options\])
### `script.runInThisContext([options])`
<!-- YAML
added: v0.3.1
changes:
Expand Down Expand Up @@ -297,7 +297,7 @@ console.log(globalVar);
// 1000
```

## Class: vm.Module
## Class: `vm.Module`
<!-- YAML
added: v13.0.0
-->
Expand Down Expand Up @@ -400,7 +400,7 @@ const contextifiedObject = vm.createContext({ secret: 42 });
})();
```

### module.dependencySpecifiers
### `module.dependencySpecifiers`

* {string[]}

Expand All @@ -410,7 +410,7 @@ to disallow any changes to it.
Corresponds to the `[[RequestedModules]]` field of [Cyclic Module Record][]s in
the ECMAScript specification.

### module.error
### `module.error`

* {any}

Expand All @@ -424,7 +424,7 @@ exception due to possible ambiguity with `throw undefined;`.
Corresponds to the `[[EvaluationError]]` field of [Cyclic Module Record][]s
in the ECMAScript specification.

### module.evaluate(\[options\])
### `module.evaluate([options])`

* `options` {Object}
* `timeout` {integer} Specifies the number of milliseconds to evaluate
Expand Down Expand Up @@ -454,7 +454,7 @@ This method cannot be called while the module is being evaluated
Corresponds to the [Evaluate() concrete method][] field of [Cyclic Module
Record][]s in the ECMAScript specification.

### module.link(linker)
### `module.link(linker)`

* `linker` {Function}
* `specifier` {string} The specifier of the requested module:
Expand Down Expand Up @@ -502,7 +502,7 @@ specification.
Corresponds to the [Link() concrete method][] field of [Cyclic Module
Record][]s in the ECMAScript specification.

### module.namespace
### `module.namespace`

* {Object}

Expand All @@ -512,7 +512,7 @@ The namespace object of the module. This is only available after linking
Corresponds to the [GetModuleNamespace][] abstract operation in the ECMAScript
specification.

### module.status
### `module.status`

* {string}

Expand All @@ -538,13 +538,13 @@ Other than `'errored'`, this status string corresponds to the specification's
`'evaluated'` in the specification, but with `[[EvaluationError]]` set to a
value that is not `undefined`.

### module.identifier
### `module.identifier`

* {string}

The identifier of the current module, as set in the constructor.

## Class: vm.SourceTextModule
## Class: `vm.SourceTextModule`
<!-- YAML
added: v9.6.0
-->
Expand All @@ -559,7 +559,7 @@ flag enabled.*
The `vm.SourceTextModule` class provides the [Source Text Module Record][] as
defined in the ECMAScript specification.

### Constructor: new vm.SourceTextModule(code\[, options\])
### Constructor: `new vm.SourceTextModule(code[, options])`

* `code` {string} JavaScript Module code to parse
* `options`
Expand Down Expand Up @@ -621,7 +621,7 @@ const contextifiedObject = vm.createContext({ secret: 42 });
})();
```

## Class: vm.SyntheticModule
## Class: `vm.SyntheticModule`
<!-- YAML
added: v13.0.0
-->
Expand Down Expand Up @@ -650,7 +650,7 @@ const module = new vm.SyntheticModule(['default'], function() {
// Use `module` in linking...
```

### Constructor: new vm.SyntheticModule(exportNames, evaluateCallback\[, options\])
### Constructor: `new vm.SyntheticModule(exportNames, evaluateCallback[, options])`
<!-- YAML
added: v13.0.0
-->
Expand All @@ -670,7 +670,7 @@ Objects assigned to the exports of this instance may allow importers of
the module to access information outside the specified `context`. Use
`vm.runInContext()` to create objects in a specific context.

### syntheticModule.setExport(name, value)
### `syntheticModule.setExport(name, value)`
<!-- YAML
added: v13.0.0
-->
Expand All @@ -697,7 +697,7 @@ const vm = require('vm');
})();
```

## vm.compileFunction(code\[, params\[, options\]\])
## `vm.compileFunction(code[, params[, options]])`
<!-- YAML
added: v10.10.0
-->
Expand Down Expand Up @@ -728,7 +728,7 @@ Compiles the given code into the provided context (if no context is
supplied, the current context is used), and returns it wrapped inside a
function with the given `params`.

## vm.createContext(\[contextObject\[, options\]\])
## `vm.createContext([contextObject[, options]])`
<!-- YAML
added: v0.3.1
changes:
Expand Down Expand Up @@ -795,7 +795,7 @@ context.
The provided `name` and `origin` of the context are made visible through the
Inspector API.

## vm.isContext(object)
## `vm.isContext(object)`
<!-- YAML
added: v0.11.7
-->
Expand All @@ -806,7 +806,7 @@ added: v0.11.7
Returns `true` if the given `oject` object has been [contextified][] using
[`vm.createContext()`][].

## vm.runInContext(code, contextifiedObject\[, options\])
## `vm.runInContext(code, contextifiedObject[, options])`
<!-- YAML
added: v0.3.1
changes:
Expand Down Expand Up @@ -885,7 +885,7 @@ console.log(util.inspect(contextObject));
// { globalVar: 1024 }
```

## vm.runInNewContext(code\[, contextObject\[, options\]\])
## `vm.runInNewContext(code[, contextObject[, options]])`
<!-- YAML
added: v0.3.1
changes:
Expand Down Expand Up @@ -982,7 +982,7 @@ console.log(util.inspect(contextObject));
// { animal: 'cat', count: 3, name: 'kitty' }
```

## vm.runInThisContext(code\[, options\])
## `vm.runInThisContext(code[, options])`
<!-- YAML
added: v0.3.1
changes:
Expand Down Expand Up @@ -1116,7 +1116,7 @@ within which it can operate. The process of creating the V8 Context and
associating it with the `contextObject` is what this document refers to as
"contextifying" the object.

## Timeout limitations when using process.nextTick(), Promises, and queueMicrotask()
## Timeout limitations when using `process.nextTick()`, Promises, and `queueMicrotask()`

Because of the internal mechanics of how the `process.nextTick()` queue and
the microtask queue that underlies Promises are implemented within V8 and
Expand Down