Class Module

Hierarchy

Module

Index

Constructors

Properties

base name path size

Methods

enumerateExports enumerateImports enumerateRanges enumerateSymbols findExportByName getExportByName ensureInitialized findBaseAddress findExportByName getBaseAddress getExportByName load

Constructors

constructor

new Module(): Module
Returns Module

Properties

base

base: NativePointer

Base address.

name

name: string

Canonical module name.

path

path: string

Full filesystem path.

size

size: number

Size in bytes.

Methods

enumerateExports

enumerateExports(): ModuleExportDetails[]
Enumerates exports of module.

Returns ModuleExportDetails[]
- Defined in index.ts:406

enumerateImports

enumerateImports(): ModuleImportDetails[]
Enumerates imports of module.

Returns ModuleImportDetails[]
- Defined in index.ts:401

enumerateRanges

enumerateRanges(protection: string): RangeDetails[]
Enumerates memory ranges of module with the name as seen in Process#enumerateModules().
Parameters
- protection: string
  
  Minimum protection of ranges to include.
Returns RangeDetails[]
- Defined in index.ts:418

enumerateSymbols

enumerateSymbols(): ModuleSymbolDetails[]
Enumerates symbols of module.

Returns ModuleSymbolDetails[]
- Defined in index.ts:411

findExportByName

findExportByName(exportName: string): null | NativePointer
Looks up the absolute address of the export named exportName.

Returns null if the export doesn't exist.
Parameters
- exportName: string
  
  Export name to find the address of.
Returns null | NativePointer
- Defined in index.ts:427

getExportByName

getExportByName(exportName: string): NativePointer
Looks up the absolute address of the export named exportName.

Throws an exception if the export doesn't exist.
Parameters
- exportName: string
  
  Export name to find the address of.
Returns NativePointer
- Defined in index.ts:436

`Static` ensureInitialized

ensureInitialized(name: string): void
Ensures that initializers of the specified module have been run. This is important during early instrumentation, i.e. code run early in the process lifetime, to be able to safely interact with APIs.

One such use-case is interacting with ObjC classes provided by a given module.
Parameters
- name: string
Returns void
- Defined in index.ts:449

`Static` findBaseAddress

findBaseAddress(name: string): null | NativePointer
Looks up the base address of the name module. Returns null if the module isn’t loaded.
Parameters
- name: string
  
  Module name or path.
Returns null | NativePointer
- Defined in index.ts:456

`Static` findExportByName

findExportByName(moduleName: null | string, exportName: string): null | NativePointer
Looks up the absolute address of the export named exportName in moduleName. If the module isn’t known you may pass null instead of its name, but this can be a costly search and should be avoided.

Returns null if the module or export doesn't exist.
Parameters
- moduleName: null | string
  
  Module name or path.
- exportName: string
  
  Export name to find the address of.
Returns null | NativePointer
- Defined in index.ts:474

`Static` getBaseAddress

getBaseAddress(name: string): NativePointer
Looks up the base address of the name module. Throws an exception if the module isn’t loaded.
Parameters
- name: string
  
  Module name or path.
Returns NativePointer
- Defined in index.ts:463

`Static` getExportByName

getExportByName(moduleName: null | string, exportName: string): NativePointer
Looks up the absolute address of the export named exportName in moduleName. If the module isn’t known you may pass null instead of its name, but this can be a costly search and should be avoided.

Throws an exception if the module or export doesn't exist.
Parameters
- moduleName: null | string
  
  Module name or path.
- exportName: string
  
  Export name to find the address of.
Returns NativePointer
- Defined in index.ts:485

`Static` load

load(name: string): Module
Loads the specified module.
Parameters
- name: string
Returns Module
- Defined in index.ts:441

Generated using TypeDoc