@types/node 17.0.45 → 18.0.2

node v17.0/v8.d.ts → node/v8.d.ts

@@ -4,7 +4,7 @@
  * ```js
  * const v8 = require('v8');
  * ```
- * @see [source](https://github.com/nodejs/node/blob/v17.0.0/lib/v8.js)
+ * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/v8.js)
  */
 declare module 'v8' {
     import { Readable } from 'node:stream';
@@ -163,6 +163,13 @@ declare module 'v8' {
      * Chrome DevTools. The JSON schema is undocumented and specific to the
      * V8 engine. Therefore, the schema may change from one version of V8 to the next.
      *
+     * Creating a heap snapshot requires memory about twice the size of the heap at
+     * the time the snapshot is created. This results in the risk of OOM killers
+     * terminating the process.
+     *
+     * Generating a snapshot is a synchronous operation which blocks the event loop
+     * for a duration depending on the heap size.
+     *
      * ```js
      * // Print heap snapshot to the console
      * const v8 = require('v8');
@@ -182,6 +189,13 @@ declare module 'v8' {
      * A heap snapshot is specific to a single V8 isolate. When using `worker threads`, a heap snapshot generated from the main thread will
      * not contain any information about the workers, and vice versa.
      *
+     * Creating a heap snapshot requires memory about twice the size of the heap at
+     * the time the snapshot is created. This results in the risk of OOM killers
+     * terminating the process.
+     *
+     * Generating a snapshot is a synchronous operation which blocks the event loop
+     * for a duration depending on the heap size.
+     *
      * ```js
      * const { writeHeapSnapshot } = require('v8');
      * const {
@@ -344,6 +358,10 @@ declare module 'v8' {
     class DefaultDeserializer extends Deserializer {}
     /**
      * Uses a `DefaultSerializer` to serialize `value` into a buffer.
+     *
+     * `ERR_BUFFER_TOO_LARGE` will be thrown when trying to
+     * serialize a huge object which requires buffer
+     * larger than `buffer.constants.MAX_LENGTH`.
      * @since v8.0.0
      */
     function serialize(value: any): Buffer;

node v17.0/vm.d.ts → node/vm.d.ts

@@ -1,7 +1,9 @@
 /**
  * The `vm` module enables compiling and running code within V8 Virtual
- * Machine contexts. **The `vm` module is not a security mechanism. Do**
- * **not use it to run untrusted code.**
+ * Machine contexts.
+ *
+ * **The `vm` module is not a security**
+ * **mechanism. Do not use it to run untrusted code.**
  *
  * JavaScript code can be compiled and run immediately or
  * compiled, saved, and run later.
@@ -32,7 +34,7 @@
  *
  * console.log(x); // 1; y is not defined.
  * ```
- * @see [source](https://github.com/nodejs/node/blob/v17.0.0/lib/vm.js)
+ * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/vm.js)
  */
 declare module 'vm' {
     interface Context extends NodeJS.Dict<any> {}

node v17.0/wasi.d.ts → node/wasi.d.ts

@@ -68,7 +68,7 @@
  * The `--experimental-wasi-unstable-preview1` CLI argument is needed for this
  * example to run.
  * @experimental
- * @see [source](https://github.com/nodejs/node/blob/v17.0.0/lib/wasi.js)
+ * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/wasi.js)
  */
 declare module 'wasi' {
     interface WASIOptions {

node v17.0/worker_threads.d.ts → node/worker_threads.d.ts

@@ -39,7 +39,7 @@
  * }
  * ```
  *
- * The above example spawns a Worker thread for each `parse()` call. In actual
+ * The above example spawns a Worker thread for each `parseJSAsync()` call. In
  * practice, use a pool of Workers for these kinds of tasks. Otherwise, the
  * overhead of creating Workers would likely exceed their benefit.
  *
@@ -49,7 +49,7 @@
  *
  * Worker threads inherit non-process-specific options by default. Refer to `Worker constructor options` to know how to customize worker thread options,
  * specifically `argv` and `execArgv` options.
- * @see [source](https://github.com/nodejs/node/blob/v17.0.0/lib/worker_threads.js)
+ * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/worker_threads.js)
  */
 declare module 'worker_threads' {
     import { Blob } from 'node:buffer';
@@ -507,7 +507,6 @@ declare module 'worker_threads' {
      * }
      * ```
      * @since v15.4.0
-     * @experimental
      */
     class BroadcastChannel {
         readonly name: string;
@@ -630,14 +629,12 @@ declare module 'worker_threads' {
      * }
      * ```
      * @since v15.12.0, v14.18.0
-     * @experimental
      * @param key Any arbitrary, cloneable JavaScript value that can be used as a {Map} key.
      */
     function getEnvironmentData(key: Serializable): Serializable;
     /**
      * The `worker.setEnvironmentData()` API sets the content of`worker.getEnvironmentData()` in the current thread and all new `Worker`instances spawned from the current context.
      * @since v15.12.0, v14.18.0
-     * @experimental
      * @param key Any arbitrary, cloneable JavaScript value that can be used as a {Map} key.
      * @param value Any arbitrary, cloneable JavaScript value that will be cloned and passed automatically to all new `Worker` instances. If `value` is passed as `undefined`, any previously set value
      * for the `key` will be deleted.

node v17.0/zlib.d.ts → node/zlib.d.ts

@@ -88,7 +88,7 @@
  *   });
  * ```
  * @since v0.5.8
- * @see [source](https://github.com/nodejs/node/blob/v17.0.0/lib/zlib.js)
+ * @see [source](https://github.com/nodejs/node/blob/v18.0.0/lib/zlib.js)
  */
 declare module 'zlib' {
     import * as stream from 'node:stream';