Module - Node documentation
class Module

Usage

import { Module } from "node:module";

Constructors

new
Module(id: string, parent?: Module)

Static Properties

builtinModules: string[]

Static Methods

createRequire(path: string | URL): NodeRequire
isBuiltin(moduleName: string): boolean
register<Data = any>(specifier: string | URL, parentURL?: string | URL, options?: RegisterOptions<Data>): void
register<Data = any>(specifier: string | URL, options?: RegisterOptions<Data>): void
runMain(): void
wrap(code: string): string
interface Module
extends NodeModule
namespace Module

Classes

c
Module.SourceMap
No documentation available

Functions

f
Module.findSourceMap

path is the resolved path for the file for which a corresponding source map should be fetched.

f
Module.syncBuiltinESMExports

The module.syncBuiltinESMExports() method updates all the live bindings for builtin ES Modules to match the properties of the CommonJS exports. It does not add or remove exported names from the ES Modules.

Interfaces

I
Module.GlobalPreloadContext
No documentation available
I
Module.ImportAttributes
No documentation available
I
Module.LoadFnOutput
No documentation available
I
Module.LoadHookContext
No documentation available
I
Module.ResolveFnOutput
No documentation available
I
Module.ResolveHookContext
No documentation available
I
Module.SourceMapPayload
No documentation available
I
Module.SourceMapping
No documentation available
I
Module.SourceOrigin
No documentation available
I
Module.ImportAssertions
No documentation available

Type Aliases

T
Module.InitializeHook

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 register.

T
Module.LoadHook

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.

T
Module.ModuleFormat
No documentation available
T
Module.ModuleSource
No documentation available
T
Module.ResolveHook

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.

T
Module.GlobalPreloadHook
No documentation available