@types/node 20.5.0 → 20.5.2

node/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for Node.js (https://nodejs.org/).
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node.
 
 ### Additional Details
- * Last updated: Sun, 13 Aug 2023 19:32:51 GMT
+ * Last updated: Tue, 22 Aug 2023 09:03:14 GMT
  * Dependencies: none
  * Global values: `AbortController`, `AbortSignal`, `__dirname`, `__filename`, `console`, `exports`, `gc`, `global`, `module`, `process`, `require`, `structuredClone`
 

node/fs.d.ts

@@ -3900,6 +3900,31 @@ declare module 'fs' {
      * @return The number of bytes read.
      */
     export function readvSync(fd: number, buffers: ReadonlyArray<NodeJS.ArrayBufferView>, position?: number): number;
+
+    export interface OpenAsBlobOptions {
+        /**
+         * An optional mime type for the blob.
+         *
+         * @default 'undefined'
+         */
+        type?: string | undefined;
+    }
+
+    /**
+     * Returns a Blob whose data is backed by the given file.
+     *
+     * The file must not be modified after the `Blob` is created.
+     * Any modifications will cause reading the `Blob` data to fail with a `DOMException` error.
+     * Synchronous stat operations on the file when the `Blob` is created, and before each read in order to detect whether the file data has been modified on disk.
+     *
+     * @param path
+     * @param [options]
+     *
+     * @experimental
+     * @since v19.8.0
+     */
+    export function openAsBlob(path: PathLike, options?: OpenAsBlobOptions): Promise<Blob>;
+
     export interface OpenDirOptions {
         /**
          * @default 'utf8'

node/module.d.ts

@@ -3,6 +3,7 @@
  */
 declare module 'module' {
     import { URL } from 'node:url';
+    import { MessagePort } from 'node:worker_threads';
     namespace Module {
         /**
          * The `module.syncBuiltinESMExports()` method updates all the live bindings for
@@ -92,6 +93,101 @@ declare module 'module' {
              */
             findEntry(lineOffset: number, columnOffset: number): SourceMapping;
         }
+        type ModuleFormat = 'builtin' | 'commonjs' | 'json' | 'module' | 'wasm';
+        type ModuleSource = string | ArrayBuffer | NodeJS.TypedArray;
+        interface GlobalPreloadContext {
+            port: MessagePort;
+        }
+        /**
+         * Sometimes it might be necessary to run some code inside of the same global scope that the application runs in.
+         * This hook allows the return of a string that is run as a sloppy-mode script on startup.
+         *
+         * @param context Information to assist the preload code
+         * @return Code to run before application startup
+         */
+        type GlobalPreloadHook = (context: GlobalPreloadContext) => string;
+        interface ResolveHookContext {
+            /**
+             * Export conditions of the relevant `package.json`
+             */
+            conditions: string[];
+            /**
+             *  An object whose key-value pairs represent the assertions for the module to import
+             */
+            importAssertions: Object;
+            /**
+             * The module importing this one, or undefined if this is the Node.js entry point
+             */
+            parentURL: string | undefined;
+        }
+        interface ResolveFnOutput {
+            /**
+             * A hint to the load hook (it might be ignored)
+             */
+            format?: ModuleFormat | null | undefined;
+            /**
+             * The import assertions to use when caching the module (optional; if excluded the input will be used)
+             */
+            importAssertions?: Object | undefined;
+            /**
+             * A signal that this hook intends to terminate the chain of `resolve` hooks.
+             * @default false
+             */
+            shortCircuit?: boolean | undefined;
+            /**
+             * The absolute URL to which this input resolves
+             */
+            url: string;
+        }
+        /**
+         * The `resolve` hook chain is responsible for resolving file URL for a given module specifier and parent URL, and optionally its format (such as `'module'`) as a hint to the `load` hook.
+         * If a format is specified, the load hook is ultimately responsible for providing the final `format` value (and it is free to ignore the hint provided by `resolve`);
+         * if `resolve` provides a format, a custom `load` hook is required even if only to pass the value to the Node.js default `load` hook.
+         *
+         * @param specifier The specified URL path of the module to be resolved
+         * @param context
+         * @param nextResolve The subsequent `resolve` hook in the chain, or the Node.js default `resolve` hook after the last user-supplied resolve hook
+         */
+        type ResolveHook = (
+            specifier: string,
+            context: ResolveHookContext,
+            nextResolve: (specifier: string, context?: ResolveHookContext) => ResolveFnOutput
+        ) => ResolveFnOutput | Promise<ResolveFnOutput>;
+        interface LoadHookContext {
+            /**
+             * Export conditions of the relevant `package.json`
+             */
+            conditions: string[];
+            /**
+             * The format optionally supplied by the `resolve` hook chain
+             */
+            format: ModuleFormat;
+            /**
+             *  An object whose key-value pairs represent the assertions for the module to import
+             */
+            importAssertions: Object;
+        }
+        interface LoadFnOutput {
+            format: ModuleFormat;
+            /**
+             * A signal that this hook intends to terminate the chain of `resolve` hooks.
+             * @default false
+             */
+            shortCircuit?: boolean | undefined;
+            /**
+             * The source for Node.js to evaluate
+             */
+            source?: ModuleSource;
+        }
+        /**
+         * The `load` hook provides a way to define a custom method of determining how a URL should be interpreted, retrieved, and parsed.
+         * It is also in charge of validating the import assertion.
+         *
+         * @param url The URL/path of the module to be loaded
+         * @param context Metadata about the module
+         * @param nextLoad The subsequent `load` hook in the chain, or the Node.js default `load` hook after the last user-supplied `load` hook
+         */
+        type LoadHook = (url: string, context: LoadHookContext, nextLoad: (url: string, context?: LoadHookContext) => LoadFnOutput) => LoadFnOutput | Promise<LoadFnOutput>;
     }
     interface Module extends NodeModule {}
     class Module {

node/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/node",
-    "version": "20.5.0",
+    "version": "20.5.2",
     "description": "TypeScript definitions for Node.js",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node",
     "license": "MIT",
@@ -227,6 +227,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "83e291a6a60ec56a2b56b6b885ae9a0ea199888a482d63f4a22270483f82f2a9",
+    "typesPublisherContentHash": "16c0c38215cd7cb1934b1390c501dfa15927a10c9b2e8a41a35779d5d94f8119",
     "typeScriptVersion": "4.3"
 }

node/ts4.8/fs.d.ts

@@ -3900,6 +3900,31 @@ declare module 'fs' {
      * @return The number of bytes read.
      */
     export function readvSync(fd: number, buffers: ReadonlyArray<NodeJS.ArrayBufferView>, position?: number): number;
+
+    export interface OpenAsBlobOptions {
+        /**
+         * An optional mime type for the blob.
+         *
+         * @default 'undefined'
+         */
+        type?: string | undefined;
+    }
+
+    /**
+     * Returns a Blob whose data is backed by the given file.
+     *
+     * The file must not be modified after the `Blob` is created.
+     * Any modifications will cause reading the `Blob` data to fail with a `DOMException` error.
+     * Synchronous stat operations on the file when the `Blob` is created, and before each read in order to detect whether the file data has been modified on disk.
+     *
+     * @param path
+     * @param [options]
+     *
+     * @experimental
+     * @since v19.8.0
+     */
+    export function openAsBlob(path: PathLike, options?: OpenAsBlobOptions): Promise<Blob>;
+
     export interface OpenDirOptions {
         /**
          * @default 'utf8'

node/ts4.8/module.d.ts

@@ -3,6 +3,7 @@
  */
 declare module 'module' {
     import { URL } from 'node:url';
+    import { MessagePort } from 'node:worker_threads';
     namespace Module {
         /**
          * The `module.syncBuiltinESMExports()` method updates all the live bindings for
@@ -92,6 +93,101 @@ declare module 'module' {
              */
             findEntry(lineOffset: number, columnOffset: number): SourceMapping;
         }
+        type ModuleFormat = 'builtin' | 'commonjs' | 'json' | 'module' | 'wasm';
+        type ModuleSource = string | ArrayBuffer | NodeJS.TypedArray;
+        interface GlobalPreloadContext {
+            port: MessagePort;
+        }
+        /**
+         * Sometimes it might be necessary to run some code inside of the same global scope that the application runs in.
+         * This hook allows the return of a string that is run as a sloppy-mode script on startup.
+         *
+         * @param context Information to assist the preload code
+         * @return Code to run before application startup
+         */
+        type GlobalPreloadHook = (context: GlobalPreloadContext) => string;
+        interface ResolveHookContext {
+            /**
+             * Export conditions of the relevant `package.json`
+             */
+            conditions: string[];
+            /**
+             *  An object whose key-value pairs represent the assertions for the module to import
+             */
+            importAssertions: Object;
+            /**
+             * The module importing this one, or undefined if this is the Node.js entry point
+             */
+            parentURL: string | undefined;
+        }
+        interface ResolveFnOutput {
+            /**
+             * A hint to the load hook (it might be ignored)
+             */
+            format?: ModuleFormat | null | undefined;
+            /**
+             * The import assertions to use when caching the module (optional; if excluded the input will be used)
+             */
+            importAssertions?: Object | undefined;
+            /**
+             * A signal that this hook intends to terminate the chain of `resolve` hooks.
+             * @default false
+             */
+            shortCircuit?: boolean | undefined;
+            /**
+             * The absolute URL to which this input resolves
+             */
+            url: string;
+        }
+        /**
+         * The `resolve` hook chain is responsible for resolving file URL for a given module specifier and parent URL, and optionally its format (such as `'module'`) as a hint to the `load` hook.
+         * If a format is specified, the load hook is ultimately responsible for providing the final `format` value (and it is free to ignore the hint provided by `resolve`);
+         * if `resolve` provides a format, a custom `load` hook is required even if only to pass the value to the Node.js default `load` hook.
+         *
+         * @param specifier The specified URL path of the module to be resolved
+         * @param context
+         * @param nextResolve The subsequent `resolve` hook in the chain, or the Node.js default `resolve` hook after the last user-supplied resolve hook
+         */
+        type ResolveHook = (
+            specifier: string,
+            context: ResolveHookContext,
+            nextResolve: (specifier: string, context?: ResolveHookContext) => ResolveFnOutput
+        ) => ResolveFnOutput | Promise<ResolveFnOutput>;
+        interface LoadHookContext {
+            /**
+             * Export conditions of the relevant `package.json`
+             */
+            conditions: string[];
+            /**
+             * The format optionally supplied by the `resolve` hook chain
+             */
+            format: ModuleFormat;
+            /**
+             *  An object whose key-value pairs represent the assertions for the module to import
+             */
+            importAssertions: Object;
+        }
+        interface LoadFnOutput {
+            format: ModuleFormat;
+            /**
+             * A signal that this hook intends to terminate the chain of `resolve` hooks.
+             * @default false
+             */
+            shortCircuit?: boolean | undefined;
+            /**
+             * The source for Node.js to evaluate
+             */
+            source?: ModuleSource;
+        }
+        /**
+         * The `load` hook provides a way to define a custom method of determining how a URL should be interpreted, retrieved, and parsed.
+         * It is also in charge of validating the import assertion.
+         *
+         * @param url The URL/path of the module to be loaded
+         * @param context Metadata about the module
+         * @param nextLoad The subsequent `load` hook in the chain, or the Node.js default `load` hook after the last user-supplied `load` hook
+         */
+        type LoadHook = (url: string, context: LoadHookContext, nextLoad: (url: string, context?: LoadHookContext) => LoadFnOutput) => LoadFnOutput | Promise<LoadFnOutput>;
     }
     interface Module extends NodeModule {}
     class Module {