@types/node 24.12.0 → 25.5.0

node v24.12/module.d.ts → node/module.d.ts

@@ -1,7 +1,7 @@
 /**
  * @since v0.3.7
  */
-declare module "module" {
+declare module "node:module" {
     import { URL } from "node:url";
     class Module {
         constructor(id: string, parent?: Module);
@@ -30,7 +30,7 @@ declare module "module" {
             /**
              * The following constants are returned as the `status` field in the object returned by
              * {@link enableCompileCache} to indicate the result of the attempt to enable the
-             * [module compile cache](https://nodejs.org/docs/latest-v24.x/api/module.html#module-compile-cache).
+             * [module compile cache](https://nodejs.org/docs/latest-v25.x/api/module.html#module-compile-cache).
              * @since v22.8.0
              */
             namespace compileCacheStatus {
@@ -62,6 +62,24 @@ declare module "module" {
                 const DISABLED: number;
             }
         }
+        interface EnableCompileCacheOptions {
+            /**
+             * Optional. Directory to store the compile cache. If not specified,
+             * the directory specified by the `NODE_COMPILE_CACHE=dir` environment variable
+             * will be used if it's set, or `path.join(os.tmpdir(), 'node-compile-cache')`
+             * otherwise.
+             * @since v25.0.0
+             */
+            directory?: string | undefined;
+            /**
+             * Optional. If `true`, enables portable compile cache so that
+             * the cache can be reused even if the project directory is moved. This is a best-effort
+             * feature. If not specified, it will depend on whether the environment variable
+             * `NODE_COMPILE_CACHE_PORTABLE=1` is set.
+             * @since v25.0.0
+             */
+            portable?: boolean | undefined;
+        }
         interface EnableCompileCacheResult {
             /**
              * One of the {@link constants.compileCacheStatus}
@@ -80,50 +98,34 @@ declare module "module" {
              */
             directory?: string;
         }
-        interface EnableCompileCacheOptions {
-            /**
-             * Optional. Directory to store the compile cache. If not specified, the directory specified by
-             * the [`NODE_COMPILE_CACHE=dir`](https://nodejs.org/docs/latest-v24.x/api/cli.html#node_compile_cachedir)
-             * environment variable will be used if it's set, or `path.join(os.tmpdir(), 'node-compile-cache')` otherwise.
-             * @since v24.12.0
-             */
-            directory?: string | undefined;
-            /**
-             * Optional. If `true`, enables portable compile cache so that the cache can be reused even if the project directory
-             * is moved. This is a best-effort feature. If not specified, it will depend on whether the environment variable
-             * [NODE_COMPILE_CACHE_PORTABLE=1](https://nodejs.org/docs/latest-v24.x/api/cli.html#node_compile_cache_portable1) is set.
-             * @since v24.12.0
-             */
-            portable?: boolean | undefined;
-        }
         /**
-         * Enable [module compile cache](https://nodejs.org/docs/latest-v24.x/api/module.html#module-compile-cache)
+         * Enable [module compile cache](https://nodejs.org/docs/latest-v25.x/api/module.html#module-compile-cache)
          * in the current Node.js instance.
          *
-         * For general use cases, it's recommended to call `module.enableCompileCache()` without specifying the
-         * `options.directory`, so that the directory can be overridden by the `NODE_COMPILE_CACHE` environment
-         * variable when necessary.
+         * For general use cases, it's recommended to call `module.enableCompileCache()` without
+         * specifying the `options.directory`, so that the directory can be overridden by the
+         * `NODE_COMPILE_CACHE` environment variable when necessary.
          *
-         * Since compile cache is supposed to be a optimization that is not mission critical, this method is
-         * designed to not throw any exception when the compile cache cannot be enabled. Instead, it will return
-         * an object containing an error message in the `message` field to aid debugging. If compile cache is
-         * enabled successfully, the `directory` field in the returned object contains the path to the directory
-         * where the compile cache is stored. The `status` field in the returned object would be one of the
-         * `module.constants.compileCacheStatus` values to indicate the result of the attempt to enable the
-         * [module compile cache](https://nodejs.org/docs/latest-v24.x/api/module.html#module-compile-cache).
+         * Since compile cache is supposed to be a optimization that is not mission critical, this
+         * method is designed to not throw any exception when the compile cache cannot be enabled.
+         * Instead, it will return an object containing an error message in the `message` field to
+         * aid debugging. If compile cache is enabled successfully, the `directory` field in the
+         * returned object contains the path to the directory where the compile cache is stored. The
+         * `status` field in the returned object would be one of the `module.constants.compileCacheStatus`
+         * values to indicate the result of the attempt to enable the
+         * [module compile cache](https://nodejs.org/docs/latest-v25.x/api/module.html#module-compile-cache).
          *
          * This method only affects the current Node.js instance. To enable it in child worker threads,
          * either call this method in child worker threads too, or set the
          * `process.env.NODE_COMPILE_CACHE` value to compile cache directory so the behavior can
          * be inherited into the child workers. The directory can be obtained either from the
-         * `directory` field returned by this method, or with {@link getCompileCacheDir `module.getCompileCacheDir()`}.
+         * `directory` field returned by this method, or with {@link getCompileCacheDir}.
          * @since v22.8.0
          * @param options Optional. If a string is passed, it is considered to be `options.directory`.
-         * will be stored/retrieved.
          */
         function enableCompileCache(options?: string | EnableCompileCacheOptions): EnableCompileCacheResult;
         /**
-         * Flush the [module compile cache](https://nodejs.org/docs/latest-v24.x/api/module.html#module-compile-cache)
+         * Flush the [module compile cache](https://nodejs.org/docs/latest-v25.x/api/module.html#module-compile-cache)
          * accumulated from modules already loaded
          * in the current Node.js instance to disk. This returns after all the flushing
          * file system operations come to an end, no matter they succeed or not. If there
@@ -134,7 +136,7 @@ declare module "module" {
         function flushCompileCache(): void;
         /**
          * @since v22.8.0
-         * @return Path to the [module compile cache](https://nodejs.org/docs/latest-v24.x/api/module.html#module-compile-cache)
+         * @return Path to the [module compile cache](https://nodejs.org/docs/latest-v25.x/api/module.html#module-compile-cache)
          * directory if it is enabled, or `undefined` otherwise.
          */
         function getCompileCacheDir(): string | undefined;
@@ -205,7 +207,7 @@ declare module "module" {
              */
             data?: Data | undefined;
             /**
-             * [Transferable objects](https://nodejs.org/docs/latest-v24.x/api/worker_threads.html#portpostmessagevalue-transferlist)
+             * [Transferable objects](https://nodejs.org/docs/latest-v25.x/api/worker_threads.html#portpostmessagevalue-transferlist)
              * to be passed into the `initialize` hook.
              */
             transferList?: any[] | undefined;
@@ -214,10 +216,10 @@ declare module "module" {
         /**
          * Register a module that exports hooks that customize Node.js module
          * resolution and loading behavior. See
-         * [Customization hooks](https://nodejs.org/docs/latest-v24.x/api/module.html#customization-hooks).
+         * [Customization hooks](https://nodejs.org/docs/latest-v25.x/api/module.html#customization-hooks).
          *
          * This feature requires `--allow-worker` if used with the
-         * [Permission Model](https://nodejs.org/docs/latest-v24.x/api/permissions.html#permission-model).
+         * [Permission Model](https://nodejs.org/docs/latest-v25.x/api/permissions.html#permission-model).
          * @since v20.6.0, v18.19.0
          * @param specifier Customization hooks to be registered; this should be
          * the same string that would be passed to `import()`, except that if it is
@@ -233,12 +235,12 @@ declare module "module" {
         function register<Data = any>(specifier: string | URL, options?: RegisterOptions<Data>): void;
         interface RegisterHooksOptions {
             /**
-             * See [load hook](https://nodejs.org/docs/latest-v24.x/api/module.html#loadurl-context-nextload).
+             * See [load hook](https://nodejs.org/docs/latest-v25.x/api/module.html#loadurl-context-nextload).
              * @default undefined
              */
             load?: LoadHookSync | undefined;
             /**
-             * See [resolve hook](https://nodejs.org/docs/latest-v24.x/api/module.html#resolvespecifier-context-nextresolve).
+             * See [resolve hook](https://nodejs.org/docs/latest-v25.x/api/module.html#resolvespecifier-context-nextresolve).
              * @default undefined
              */
             resolve?: ResolveHookSync | undefined;
@@ -250,7 +252,7 @@ declare module "module" {
             deregister(): void;
         }
         /**
-         * Register [hooks](https://nodejs.org/docs/latest-v24.x/api/module.html#customization-hooks)
+         * Register [hooks](https://nodejs.org/docs/latest-v25.x/api/module.html#customization-hooks)
          * that customize Node.js module resolution and loading behavior.
          * @since v22.15.0
          * @experimental
@@ -281,9 +283,9 @@ declare module "module" {
          * with `vm.runInContext()` or `vm.compileFunction()`.
          * By default, it will throw an error if the code contains TypeScript features
          * that require transformation such as `Enums`,
-         * see [type-stripping](https://nodejs.org/docs/latest-v24.x/api/typescript.md#type-stripping) for more information.
+         * see [type-stripping](https://nodejs.org/docs/latest-v25.x/api/typescript.md#type-stripping) for more information.
          * When mode is `'transform'`, it also transforms TypeScript features to JavaScript,
-         * see [transform TypeScript features](https://nodejs.org/docs/latest-v24.x/api/typescript.md#typescript-features) for more information.
+         * see [transform TypeScript features](https://nodejs.org/docs/latest-v25.x/api/typescript.md#typescript-features) for more information.
          * When mode is `'strip'`, source maps are not generated, because locations are preserved.
          * If `sourceMap` is provided, when mode is `'strip'`, an error will be thrown.
          *
@@ -381,59 +383,18 @@ declare module "module" {
             | "module-typescript"
             | "wasm";
         type ModuleSource = string | ArrayBuffer | NodeJS.TypedArray;
-        /**
-         * The `initialize` hook provides a way to define a custom function that runs in
-         * the hooks thread when the hooks module is initialized. Initialization happens
-         * when the hooks module is registered via {@link register}.
-         *
-         * This hook can receive data from a {@link register} invocation, including
-         * ports and other transferable objects. The return value of `initialize` can be a
-         * `Promise`, in which case it will be awaited before the main application thread
-         * execution resumes.
-         */
         type InitializeHook<Data = any> = (data: Data) => void | Promise<void>;
         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
-             */
             importAttributes: ImportAttributes;
-            /**
-             * 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); can be an intermediary value.
-             */
             format?: string | null | undefined;
-            /**
-             * The import attributes to use when caching the module (optional; if excluded the input will be used)
-             */
             importAttributes?: ImportAttributes | 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 telling Node.js where to find and
-         * how to cache a given `import` statement or expression, or `require` call. It can
-         * optionally return a 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.
-         */
         type ResolveHook = (
             specifier: string,
             context: ResolveHookContext,
@@ -451,36 +412,15 @@ declare module "module" {
             ) => ResolveFnOutput,
         ) => ResolveFnOutput;
         interface LoadHookContext {
-            /**
-             * Export conditions of the relevant `package.json`
-             */
             conditions: string[];
-            /**
-             * The format optionally supplied by the `resolve` hook chain (can be an intermediary value).
-             */
             format: string | null | undefined;
-            /**
-             *  An object whose key-value pairs represent the assertions for the module to import
-             */
             importAttributes: ImportAttributes;
         }
         interface LoadFnOutput {
             format: string | null | undefined;
-            /**
-             * 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 | undefined;
         }
-        /**
-         * 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 attributes.
-         */
         type LoadHook = (
             url: string,
             context: LoadHookContext,
@@ -634,94 +574,6 @@ declare module "module" {
         function wrap(script: string): string;
     }
     global {
-        interface ImportMeta {
-            /**
-             * The directory name of the current module.
-             *
-             * This is the same as the `path.dirname()` of the `import.meta.filename`.
-             *
-             * > **Caveat**: only present on `file:` modules.
-             * @since v21.2.0, v20.11.0
-             */
-            dirname: string;
-            /**
-             * The full absolute path and filename of the current module, with
-             * symlinks resolved.
-             *
-             * This is the same as the `url.fileURLToPath()` of the `import.meta.url`.
-             *
-             * > **Caveat** only local modules support this property. Modules not using the
-             * > `file:` protocol will not provide it.
-             * @since v21.2.0, v20.11.0
-             */
-            filename: string;
-            /**
-             * The absolute `file:` URL of the module.
-             *
-             * This is defined exactly the same as it is in browsers providing the URL of the
-             * current module file.
-             *
-             * This enables useful patterns such as relative file loading:
-             *
-             * ```js
-             * import { readFileSync } from 'node:fs';
-             * const buffer = readFileSync(new URL('./data.proto', import.meta.url));
-             * ```
-             */
-            url: string;
-            /**
-             * `import.meta.resolve` is a module-relative resolution function scoped to
-             * each module, returning the URL string.
-             *
-             * ```js
-             * const dependencyAsset = import.meta.resolve('component-lib/asset.css');
-             * // file:///app/node_modules/component-lib/asset.css
-             * import.meta.resolve('./dep.js');
-             * // file:///app/dep.js
-             * ```
-             *
-             * All features of the Node.js module resolution are supported. Dependency
-             * resolutions are subject to the permitted exports resolutions within the package.
-             *
-             * **Caveats**:
-             *
-             * * This can result in synchronous file-system operations, which
-             *   can impact performance similarly to `require.resolve`.
-             * * This feature is not available within custom loaders (it would
-             *   create a deadlock).
-             * @since v13.9.0, v12.16.0
-             * @param specifier The module specifier to resolve relative to the
-             * current module.
-             * @param parent An optional absolute parent module URL to resolve from.
-             * **Default:** `import.meta.url`
-             * @returns The absolute URL string that the specifier would resolve to.
-             */
-            resolve(specifier: string, parent?: string | URL): string;
-            /**
-             * `true` when the current module is the entry point of the current process; `false` otherwise.
-             *
-             * Equivalent to `require.main === module` in CommonJS.
-             *
-             * Analogous to Python's `__name__ == "__main__"`.
-             *
-             * ```js
-             * export function foo() {
-             *   return 'Hello, world';
-             * }
-             *
-             * function main() {
-             *   const message = foo();
-             *   console.log(message);
-             * }
-             *
-             * if (import.meta.main) main();
-             * // `foo` can be imported from another module without possible side-effects from `main`
-             * ```
-             * @since v24.2.0
-             * @experimental
-             */
-            main: boolean;
-        }
         namespace NodeJS {
             interface Module {
                 /**
@@ -795,7 +647,7 @@ declare module "module" {
                  * Modules are cached in this object when they are required. By deleting a key
                  * value from this object, the next `require` will reload the module.
                  * This does not apply to
-                 * [native addons](https://nodejs.org/docs/latest-v24.x/api/addons.html),
+                 * [native addons](https://nodejs.org/docs/latest-v25.x/api/addons.html),
                  * for which reloading will result in an error.
                  * @since v0.3.0
                  */
@@ -829,7 +681,7 @@ declare module "module" {
                  * Paths to resolve module location from. If present, these
                  * paths are used instead of the default resolution paths, with the exception
                  * of
-                 * [GLOBAL\_FOLDERS](https://nodejs.org/docs/latest-v24.x/api/modules.html#loading-from-the-global-folders)
+                 * [GLOBAL\_FOLDERS](https://nodejs.org/docs/latest-v25.x/api/modules.html#loading-from-the-global-folders)
                  * like `$HOME/.node_modules`, which are
                  * always included. Each of these paths is used as a starting point for
                  * the module resolution algorithm, meaning that the `node_modules` hierarchy
@@ -899,7 +751,7 @@ declare module "module" {
     }
     export = Module;
 }
-declare module "node:module" {
-    import module = require("module");
+declare module "module" {
+    import module = require("node:module");
     export = module;
 }