Module - module - Node

class Module

Usage in Deno

import { Module } from "node:module";

<div class="alert alert-warning"><div><svg xmlns="http://www.w3.org/2000/svg" width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"> <path stroke="none" d="M0 0h24v24H0z" fill="none" /> <path d="M12 9v4" /> <path d="M10.363 3.591l-8.106 13.534a1.914 1.914 0 0 0 1.636 2.871h16.214a1.914 1.914 0 0 0 1.636 -2.87l-8.106 -13.536a1.914 1.914 0 0 0 -3.274 0z" /> <path d="M12 16h.01" /> </svg> Deno compatibility</div><div><p> The <code>register</code> method is a non-functional stub.</p> </div></div>

Constructors

new



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

Static Properties



Module: Module



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

Module.SourceMap

No documentation available

Functions

Module.findSourceMap

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

Module.syncBuiltinESMExports

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

Interfaces

Module.GlobalPreloadContext

No documentation available

port

Module.ImportAttributes

No documentation available

type

Module.LoadFnOutput

No documentation available

Module.LoadHookContext

No documentation available

Module.ResolveFnOutput

No documentation available

Module.ResolveHookContext

No documentation available

Module.SourceMapPayload

No documentation available

Module.SourceMapping

No documentation available

Module.SourceOrigin

No documentation available

Type Aliases

Module.InitializeHook

The initialize hook provides a way to define a custom function that runs in the hooks threadwhen the hooks module is initialized. Initialization happens when the hooks module is registered via register.

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.

Module.ModuleFormat

No documentation available

Module.ModuleSource

No documentation available

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.

Module.GlobalPreloadHook

No documentation available