Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nodejs/node.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRich Trott <rtrott@gmail.com>2021-10-11 07:55:04 +0300
committerAntoine du Hamel <duhamelantoine1995@gmail.com>2021-10-20 12:59:11 +0300
commitd0b58c0287e67a139137aa906819d95f8314b093 (patch)
treee9a92870138d89b608b1c6e6568611744c32c4f2 /doc/api/globals.md
parenta7c17e08de658cbc0beefd8e9583803b5a62ac7e (diff)
doc: format doc/api/*.md with markdown formatter
PR-URL: https://github.com/nodejs/node/pull/40403 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Zijian Liu <lxxyxzj@gmail.com> Reviewed-By: Michaƫl Zasso <targos@protonmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Diffstat (limited to 'doc/api/globals.md')
-rw-r--r--doc/api/globals.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/doc/api/globals.md b/doc/api/globals.md
index abb992ebe9a..3d2155176a9 100644
--- a/doc/api/globals.md
+++ b/doc/api/globals.md
@@ -19,6 +19,7 @@ that are part of the JavaScript language itself, which are also globally
accessible.
## Class: `AbortController`
+
<!-- YAML
added:
- v15.0.0
@@ -46,6 +47,7 @@ console.log(ac.signal.aborted); // Prints True
```
### `abortController.abort()`
+
<!-- YAML
added:
- v15.0.0
@@ -56,6 +58,7 @@ Triggers the abort signal, causing the `abortController.signal` to emit
the `'abort'` event.
### `abortController.signal`
+
<!-- YAML
added:
- v15.0.0
@@ -65,6 +68,7 @@ added:
* Type: {AbortSignal}
### Class: `AbortSignal`
+
<!-- YAML
added:
- v15.0.0
@@ -77,6 +81,7 @@ The `AbortSignal` is used to notify observers when the
`abortController.abort()` method is called.
#### Static method: `AbortSignal.abort()`
+
<!-- YAML
added:
- v15.12.0
@@ -88,6 +93,7 @@ added:
Returns a new already aborted `AbortSignal`.
#### Event: `'abort'`
+
<!-- YAML
added:
- v15.0.0
@@ -124,6 +130,7 @@ removed as soon as the `'abort'` event is handled. Failure to do so may
result in memory leaks.
#### `abortSignal.aborted`
+
<!-- YAML
added:
- v15.0.0
@@ -133,6 +140,7 @@ added:
* Type: {boolean} True after the `AbortController` has been aborted.
#### `abortSignal.onabort`
+
<!-- YAML
added:
- v15.0.0
@@ -145,6 +153,7 @@ An optional callback function that may be set by user code to be notified
when the `abortController.abort()` function has been called.
## Class: `Buffer`
+
<!-- YAML
added: v0.1.103
-->
@@ -164,6 +173,7 @@ This variable may appear to be global but is not. See [`__dirname`][].
This variable may appear to be global but is not. See [`__filename`][].
## `atob(data)`
+
<!-- YAML
added: v16.0.0
-->
@@ -173,6 +183,7 @@ added: v16.0.0
Global alias for [`buffer.atob()`][].
## `btoa(data)`
+
<!-- YAML
added: v16.0.0
-->
@@ -182,6 +193,7 @@ added: v16.0.0
Global alias for [`buffer.btoa()`][].
## `clearImmediate(immediateObject)`
+
<!-- YAML
added: v0.9.1
-->
@@ -191,6 +203,7 @@ added: v0.9.1
[`clearImmediate`][] is described in the [timers][] section.
## `clearInterval(intervalObject)`
+
<!-- YAML
added: v0.0.1
-->
@@ -200,6 +213,7 @@ added: v0.0.1
[`clearInterval`][] is described in the [timers][] section.
## `clearTimeout(timeoutObject)`
+
<!-- YAML
added: v0.0.1
-->
@@ -209,6 +223,7 @@ added: v0.0.1
[`clearTimeout`][] is described in the [timers][] section.
## `console`
+
<!-- YAML
added: v0.1.100
-->
@@ -220,6 +235,7 @@ added: v0.1.100
Used to print to stdout and stderr. See the [`console`][] section.
## `Event`
+
<!-- YAML
added: v15.0.0
changes:
@@ -234,6 +250,7 @@ A browser-compatible implementation of the `Event` class. See
[`EventTarget` and `Event` API][] for more details.
## `EventTarget`
+
<!-- YAML
added: v15.0.0
changes:
@@ -252,6 +269,7 @@ A browser-compatible implementation of the `EventTarget` class. See
This variable may appear to be global but is not. See [`exports`][].
## `global`
+
<!-- YAML
added: v0.1.27
-->
@@ -266,6 +284,7 @@ Node.js this is different. The top-level scope is not the global scope;
`var something` inside a Node.js module will be local to that module.
## `MessageChannel`
+
<!-- YAML
added: v15.0.0
-->
@@ -275,6 +294,7 @@ added: v15.0.0
The `MessageChannel` class. See [`MessageChannel`][] for more details.
## `MessageEvent`
+
<!-- YAML
added: v15.0.0
-->
@@ -284,6 +304,7 @@ added: v15.0.0
The `MessageEvent` class. See [`MessageEvent`][] for more details.
## `MessagePort`
+
<!-- YAML
added: v15.0.0
-->
@@ -301,6 +322,7 @@ This variable may appear to be global but is not. See [`module`][].
The [`perf_hooks.performance`][] object.
## `process`
+
<!-- YAML
added: v0.1.7
-->
@@ -312,6 +334,7 @@ added: v0.1.7
The process object. See the [`process` object][] section.
## `queueMicrotask(callback)`
+
<!-- YAML
added: v11.0.0
-->
@@ -355,6 +378,7 @@ DataHandler.prototype.load = async function load(key) {
This variable may appear to be global but is not. See [`require()`][].
## `setImmediate(callback[, ...args])`
+
<!-- YAML
added: v0.9.1
-->
@@ -364,6 +388,7 @@ added: v0.9.1
[`setImmediate`][] is described in the [timers][] section.
## `setInterval(callback, delay[, ...args])`
+
<!-- YAML
added: v0.0.1
-->
@@ -373,6 +398,7 @@ added: v0.0.1
[`setInterval`][] is described in the [timers][] section.
## `setTimeout(callback, delay[, ...args])`
+
<!-- YAML
added: v0.0.1
-->
@@ -382,6 +408,7 @@ added: v0.0.1
[`setTimeout`][] is described in the [timers][] section.
## `DOMException`
+
<!-- YAML
added: v17.0.0
-->
@@ -391,6 +418,7 @@ added: v17.0.0
The WHATWG `DOMException` class. See [`DOMException`][] for more details.
## `TextDecoder`
+
<!-- YAML
added: v11.0.0
-->
@@ -400,6 +428,7 @@ added: v11.0.0
The WHATWG `TextDecoder` class. See the [`TextDecoder`][] section.
## `TextEncoder`
+
<!-- YAML
added: v11.0.0
-->
@@ -409,6 +438,7 @@ added: v11.0.0
The WHATWG `TextEncoder` class. See the [`TextEncoder`][] section.
## `URL`
+
<!-- YAML
added: v10.0.0
-->
@@ -418,6 +448,7 @@ added: v10.0.0
The WHATWG `URL` class. See the [`URL`][] section.
## `URLSearchParams`
+
<!-- YAML
added: v10.0.0
-->
@@ -427,6 +458,7 @@ added: v10.0.0
The WHATWG `URLSearchParams` class. See the [`URLSearchParams`][] section.
## `WebAssembly`
+
<!-- YAML
added: v8.0.0
-->