Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit faac17d

Browse files
ovflowdgithub-actions[bot]
ovflowd
authored and
github-actions[bot]
committed
chore(api): sync auto-generated docs
1 parent 88e675d commit faac17d

63 files changed

Lines changed: 4027 additions & 3807 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎content/api/v18/addons.en.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ category: 'api'
55
version: 'v18'
66
---
77

8-
<Metadata version="v18.9.0" data={{"update":{"type":"introduced_in","version":["v0.10.0"]}}} />
8+
<Metadata version="v18.10.0" data={{"update":{"type":"introduced_in","version":["v0.10.0"]}}} />
99

10-
<Metadata version="v18.9.0" data={{"type":"misc"}} />
10+
<Metadata version="v18.10.0" data={{"type":"misc"}} />
1111

1212
_Addons_ are dynamically-linked shared objects written in C++. The
1313
[`require()`][require] function can load addons as ordinary Node.js modules.
@@ -241,7 +241,7 @@ NODE_MODULE_INIT(/* exports, module, context */) {
241241
242242
##### Worker support
243243
244-
<Metadata version="v18.9.0" data={{"changes":[{"version":["v14.8.0","v12.19.0"],"pr-url":"https://github.com/nodejs/node/pull/34572","description":"Cleanup hooks may now be asynchronous."}]}} />
244+
<Metadata version="v18.10.0" data={{"changes":[{"version":["v14.8.0","v12.19.0"],"pr-url":"https://github.com/nodejs/node/pull/34572","description":"Cleanup hooks may now be asynchronous."}]}} />
245245
246246
In order to be loaded from multiple Node.js environments,
247247
such as a main thread and a Worker thread, an add-on needs to either:
@@ -440,7 +440,7 @@ illustration of how it can be used.
440440

441441
### Node-API
442442

443-
<Metadata version="v18.9.0" data={{"stability":{"level":2,"text":" - Stable"}}} />
443+
<Metadata version="v18.10.0" data={{"stability":{"level":2,"text":" - Stable"}}} />
444444

445445
Node-API is an API for building native addons. It is independent from
446446
the underlying JavaScript runtime (e.g. V8) and is maintained as part of

‎content/api/v18/assert.en.md‎

Lines changed: 39 additions & 39 deletions
Large diffs are not rendered by default.

‎content/api/v18/async_context.en.md‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ category: 'api'
55
version: 'v18'
66
---
77

8-
<Metadata version="v18.9.0" data={{"update":{"type":"introduced_in","version":["v16.4.0"]}}} />
8+
<Metadata version="v18.10.0" data={{"update":{"type":"introduced_in","version":["v16.4.0"]}}} />
99

10-
<Metadata version="v18.9.0" data={{"stability":{"level":2,"text":" - Stable"}}} />
10+
<Metadata version="v18.10.0" data={{"stability":{"level":2,"text":" - Stable"}}} />
1111

12-
<Metadata version="v18.9.0" data={{"source_link":"lib/async_hooks.js"}} />
12+
<Metadata version="v18.10.0" data={{"source_link":"lib/async_hooks.js"}} />
1313

1414
### Introduction
1515

@@ -32,7 +32,7 @@ const { AsyncLocalStorage, AsyncResource } = require('node:async_hooks');
3232

3333
### <DataTag tag="C" /> `AsyncLocalStorage`
3434

35-
<Metadata version="v18.9.0" data={{"changes":[{"version":"v16.4.0","pr-url":"https://github.com/nodejs/node/pull/37675","description":"AsyncLocalStorage is now Stable. Previously, it had been Experimental."}],"update":{"type":"added","version":["v13.10.0","v12.17.0"]}}} />
35+
<Metadata version="v18.10.0" data={{"changes":[{"version":"v16.4.0","pr-url":"https://github.com/nodejs/node/pull/37675","description":"AsyncLocalStorage is now Stable. Previously, it had been Experimental."}],"update":{"type":"added","version":["v13.10.0","v12.17.0"]}}} />
3636

3737
This class creates stores that stay coherent through asynchronous operations.
3838

@@ -115,16 +115,16 @@ with each other's data.
115115

116116
#### <DataTag tag="M" /> `new AsyncLocalStorage()`
117117

118-
<Metadata version="v18.9.0" data={{"update":{"type":"added","version":["v13.10.0","v12.17.0"]}}} />
118+
<Metadata version="v18.10.0" data={{"update":{"type":"added","version":["v13.10.0","v12.17.0"]}}} />
119119

120120
Creates a new instance of `AsyncLocalStorage`. Store is only provided within a
121121
`run()` call or after an `enterWith()` call.
122122

123123
#### <DataTag tag="M" /> `asyncLocalStorage.disable()`
124124

125-
<Metadata version="v18.9.0" data={{"update":{"type":"added","version":["v13.10.0","v12.17.0"]}}} />
125+
<Metadata version="v18.10.0" data={{"update":{"type":"added","version":["v13.10.0","v12.17.0"]}}} />
126126

127-
<Metadata version="v18.9.0" data={{"stability":{"level":1,"text":" - Experimental"}}} />
127+
<Metadata version="v18.10.0" data={{"stability":{"level":1,"text":" - Experimental"}}} />
128128

129129
Disables the instance of `AsyncLocalStorage`. All subsequent calls
130130
to `asyncLocalStorage.getStore()` will return `undefined` until
@@ -143,7 +143,7 @@ in the current process.
143143

144144
#### <DataTag tag="M" /> `asyncLocalStorage.getStore()`
145145

146-
<Metadata version="v18.9.0" data={{"update":{"type":"added","version":["v13.10.0","v12.17.0"]}}} />
146+
<Metadata version="v18.10.0" data={{"update":{"type":"added","version":["v13.10.0","v12.17.0"]}}} />
147147

148148
* Returns: [`any`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types)
149149

@@ -154,9 +154,9 @@ returns `undefined`.
154154

155155
#### <DataTag tag="M" /> `asyncLocalStorage.enterWith(store)`
156156

157-
<Metadata version="v18.9.0" data={{"update":{"type":"added","version":["v13.11.0","v12.17.0"]}}} />
157+
<Metadata version="v18.10.0" data={{"update":{"type":"added","version":["v13.11.0","v12.17.0"]}}} />
158158

159-
<Metadata version="v18.9.0" data={{"stability":{"level":1,"text":" - Experimental"}}} />
159+
<Metadata version="v18.10.0" data={{"stability":{"level":1,"text":" - Experimental"}}} />
160160

161161
* `store` [`any`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types)
162162

@@ -200,7 +200,7 @@ asyncLocalStorage.getStore(); // Returns the same object
200200

201201
#### <DataTag tag="M" /> `asyncLocalStorage.run(store, callback[, ...args])`
202202

203-
<Metadata version="v18.9.0" data={{"update":{"type":"added","version":["v13.10.0","v12.17.0"]}}} />
203+
<Metadata version="v18.10.0" data={{"update":{"type":"added","version":["v13.10.0","v12.17.0"]}}} />
204204

205205
* `store` [`any`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types)
206206
* `callback` [`Function`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function)
@@ -236,9 +236,9 @@ try {
236236

237237
#### <DataTag tag="M" /> `asyncLocalStorage.exit(callback[, ...args])`
238238

239-
<Metadata version="v18.9.0" data={{"update":{"type":"added","version":["v13.10.0","v12.17.0"]}}} />
239+
<Metadata version="v18.10.0" data={{"update":{"type":"added","version":["v13.10.0","v12.17.0"]}}} />
240240

241-
<Metadata version="v18.9.0" data={{"stability":{"level":1,"text":" - Experimental"}}} />
241+
<Metadata version="v18.10.0" data={{"stability":{"level":1,"text":" - Experimental"}}} />
242242

243243
* `callback` [`Function`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function)
244244
* `...args` [`any`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types)
@@ -305,7 +305,7 @@ probably responsible for the context loss.
305305

306306
### <DataTag tag="C" /> `AsyncResource`
307307

308-
<Metadata version="v18.9.0" data={{"changes":[{"version":"v16.4.0","pr-url":"https://github.com/nodejs/node/pull/37675","description":"AsyncResource is now Stable. Previously, it had been Experimental."}]}} />
308+
<Metadata version="v18.10.0" data={{"changes":[{"version":"v16.4.0","pr-url":"https://github.com/nodejs/node/pull/37675","description":"AsyncResource is now Stable. Previously, it had been Experimental."}]}} />
309309

310310
The class `AsyncResource` is designed to be extended by the embedder's async
311311
resources. Using this, users can easily trigger the lifetime events of their
@@ -409,7 +409,7 @@ class DBQuery extends AsyncResource {
409409

410410
#### Static method: `AsyncResource.bind(fn[, type[, thisArg]])`
411411

412-
<Metadata version="v18.9.0" data={{"changes":[{"version":"v17.8.0","pr-url":"https://github.com/nodejs/node/pull/42177","description":"Changed the default when `thisArg` is undefined to use `this` from the caller."},{"version":"v16.0.0","pr-url":"https://github.com/nodejs/node/pull/36782","description":"Added optional thisArg."}],"update":{"type":"added","version":["v14.8.0","v12.19.0"]}}} />
412+
<Metadata version="v18.10.0" data={{"changes":[{"version":"v17.8.0","pr-url":"https://github.com/nodejs/node/pull/42177","description":"Changed the default when `thisArg` is undefined to use `this` from the caller."},{"version":"v16.0.0","pr-url":"https://github.com/nodejs/node/pull/36782","description":"Added optional thisArg."}],"update":{"type":"added","version":["v14.8.0","v12.19.0"]}}} />
413413

414414
* `fn` [`Function`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function) The function to bind to the current execution context.
415415
* `type` [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type) An optional name to associate with the underlying
@@ -423,7 +423,7 @@ the `AsyncResource` to which the function is bound.
423423

424424
#### <DataTag tag="M" /> `asyncResource.bind(fn[, thisArg])`
425425

426-
<Metadata version="v18.9.0" data={{"changes":[{"version":"v17.8.0","pr-url":"https://github.com/nodejs/node/pull/42177","description":"Changed the default when `thisArg` is undefined to use `this` from the caller."},{"version":"v16.0.0","pr-url":"https://github.com/nodejs/node/pull/36782","description":"Added optional thisArg."}],"update":{"type":"added","version":["v14.8.0","v12.19.0"]}}} />
426+
<Metadata version="v18.10.0" data={{"changes":[{"version":"v17.8.0","pr-url":"https://github.com/nodejs/node/pull/42177","description":"Changed the default when `thisArg` is undefined to use `this` from the caller."},{"version":"v16.0.0","pr-url":"https://github.com/nodejs/node/pull/36782","description":"Added optional thisArg."}],"update":{"type":"added","version":["v14.8.0","v12.19.0"]}}} />
427427

428428
* `fn` [`Function`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function) The function to bind to the current `AsyncResource`.
429429
* `thisArg` [`any`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Data_types)
@@ -435,7 +435,7 @@ the `AsyncResource` to which the function is bound.
435435

436436
#### <DataTag tag="M" /> `asyncResource.runInAsyncScope(fn[, thisArg, ...args])`
437437

438-
<Metadata version="v18.9.0" data={{"update":{"type":"added","version":["v9.6.0"]}}} />
438+
<Metadata version="v18.10.0" data={{"update":{"type":"added","version":["v9.6.0"]}}} />
439439

440440
* `fn` [`Function`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function) The function to call in the execution context of this async
441441
resource.

‎content/api/v18/async_hooks.en.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ category: 'api'
55
version: 'v18'
66
---
77

8-
<Metadata version="v18.9.0" data={{"update":{"type":"introduced_in","version":["v8.1.0"]}}} />
8+
<Metadata version="v18.10.0" data={{"update":{"type":"introduced_in","version":["v8.1.0"]}}} />
99

10-
<Metadata version="v18.9.0" data={{"stability":{"level":1,"text":" - Experimental"}}} />
10+
<Metadata version="v18.10.0" data={{"stability":{"level":1,"text":" - Experimental"}}} />
1111

12-
<Metadata version="v18.9.0" data={{"source_link":"lib/async_hooks.js"}} />
12+
<Metadata version="v18.10.0" data={{"source_link":"lib/async_hooks.js"}} />
1313

1414
The `node:async_hooks` module provides an API to track asynchronous resources.
1515
It can be accessed using:
@@ -136,7 +136,7 @@ function promiseResolve(asyncId) { }
136136

137137
### <DataTag tag="M" /> `async_hooks.createHook(callbacks)`
138138

139-
<Metadata version="v18.9.0" data={{"update":{"type":"added","version":["v8.1.0"]}}} />
139+
<Metadata version="v18.10.0" data={{"update":{"type":"added","version":["v8.1.0"]}}} />
140140

141141
* `callbacks` [`Object`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) The [Hook Callbacks][] to register
142142
* `init` [`Function`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function) The [`init` callback][].
@@ -573,7 +573,7 @@ does not depend on garbage collection, then this will not be an issue.
573573

574574
##### <DataTag tag="M" /> `promiseResolve(asyncId)`
575575

576-
<Metadata version="v18.9.0" data={{"update":{"type":"added","version":["v8.6.0"]}}} />
576+
<Metadata version="v18.10.0" data={{"update":{"type":"added","version":["v8.6.0"]}}} />
577577

578578
* `asyncId` [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type)
579579

@@ -602,7 +602,7 @@ init for PROMISE with id 6, trigger id: 5 # the Promise returned by then()
602602

603603
#### <DataTag tag="M" /> `async_hooks.executionAsyncResource()`
604604

605-
<Metadata version="v18.9.0" data={{"update":{"type":"added","version":["v13.9.0","v12.17.0"]}}} />
605+
<Metadata version="v18.10.0" data={{"update":{"type":"added","version":["v13.9.0","v12.17.0"]}}} />
606606

607607
* Returns: [`Object`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) The resource representing the current execution.
608608
Useful to store data within the resource.
@@ -692,7 +692,7 @@ const server = createServer((req, res) => {
692692
693693
#### <DataTag tag="M" /> `async_hooks.executionAsyncId()`
694694
695-
<Metadata version="v18.9.0" data={{"changes":[{"version":"v8.2.0","pr-url":"https://github.com/nodejs/node/pull/13490","description":"Renamed from `currentId`."}],"update":{"type":"added","version":["v8.1.0"]}}} />
695+
<Metadata version="v18.10.0" data={{"changes":[{"version":"v8.2.0","pr-url":"https://github.com/nodejs/node/pull/13490","description":"Renamed from `currentId`."}],"update":{"type":"added","version":["v8.1.0"]}}} />
696696
697697
* Returns: [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type) The `asyncId` of the current execution context. Useful to
698698
track when something calls.
@@ -759,7 +759,7 @@ the section on [promise execution tracking][].
759759
760760
#### <DataTag tag="M" /> `async_hooks.asyncWrapProviders`
761761
762-
<Metadata version="v18.9.0" data={{"update":{"type":"added","version":["v17.2.0","v16.14.0"]}}} />
762+
<Metadata version="v18.10.0" data={{"update":{"type":"added","version":["v17.2.0","v16.14.0"]}}} />
763763
764764
* Returns: A map of provider types to the corresponding numeric id.
765765
This map contains all the event types that might be emitted by the `async_hooks.init()` event.

0 commit comments

Comments
 (0)