FaasJS
Home
  • Guide
  • Documents
  • Templates
  • Changelog
  • Ecosystem

    • Docker Images
  • Github
  • Contributing
  • Sponsor
  • Security
Home
  • Guide
  • Documents
  • Templates
  • Changelog
  • Ecosystem

    • Docker Images
  • Github
  • Contributing
  • Sponsor
  • Security

Documents / @faasjs/node-utils / registerNodeModuleHooks

Function: registerNodeModuleHooks()

registerNodeModuleHooks(options?): void

Install Node module hooks for tsconfig path aliases and TypeScript-friendly local imports.

Calling this function multiple times is safe. Hooks are installed once, while loader state is refreshed from the latest options when a root, entry, or tsconfig path can be inferred. The hooks resolve tsconfig paths, extensionless local script imports, and optional cache-busting query strings for project-local file:// URLs.

Parameters

options?

RegisterNodeModuleHooksOptions = {}

Hook registration options such as entry file, root, tsconfig path, and cache-busting version.

Returns

void

Default

{
}

Example

import { registerNodeModuleHooks } from '@faasjs/node-utils'

registerNodeModuleHooks({
  root: process.cwd(),
})