Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Module

Hierarchy

Index

Classes

Interfaces

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    • id: string
    • Optional parent: Module

    Returns Module

Properties

children

children: Module[]

exports

exports: any

filename

filename: string

id

id: string

loaded

loaded: boolean

parent

parent: Module | null | undefined
deprecated

since 14.6.0 Please use require.main and module.children instead.

path

path: string
since

11.14.0

The directory name of the module. This is usually the same as the path.dirname() of the module.id.

paths

paths: string[]

require

require: Require

Static Module

Module: Module

Static builtinModules

builtinModules: string[]

Methods

Static createRequire

  • Parameters

    • path: string | URL

    Returns NodeRequire

Static createRequireFromPath

  • deprecated

    Deprecated since: v12.2.0. Please use createRequire() instead.

    Parameters

    • path: string

    Returns NodeRequire

Static findSourceMap

  • Parameters

    • path: string
    • Optional error: Error

    Returns SourceMap

Static runMain

  • runMain(): void

  • Returns void

Static syncBuiltinESMExports

  • syncBuiltinESMExports(): void

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

    Returns void

Static wrap

  • wrap(code: string): string

  • Parameters

    • code: string

    Returns string

Generated using TypeDoc