load-module

load-module

Standard dynamic imports intended for runtime loading of user-defined modules (e.g. plugins).

• Search for modules in one or more specific folders.
• Specify a base folder from which to resolve from (e.g. the current working directory).

Synopsis

import { loadModule } from 'load-module'

const ViewClass = await loadModule('default-view', { paths: '~/my-view-folder'})
const view = new ViewClass()

load-module

• load-module
  • loadModule(specifier, options)
  • loadModuleSpecifier(specifier)
  • loadModuleResolvedFrom(specifier, paths)
  • loadModuleRelativeTo(specifier, paths)

loadModule(specifier, options)

Kind: exported function

Param	Type	Description
specifier	string	A valid Node.js module specifier.
options.paths	string[]	One or more directories to pass to both loadModuleResolvedFrom and loadModuleRelativeTo.
options.resolvedFromPaths	string[]	Specific directories to pass to loadModuleResolvedFrom.
options.relativeToPaths	string[]	Specific directories to pass to loadModuleRelativeTo.

loadModuleSpecifier(specifier)

Kind: exported function

Param	Type	Description
specifier	string	A valid Node.js module specifier.

loadModuleResolvedFrom(specifier, paths)

Kind: exported function

Param	Type	Description
specifier	string	A valid Node.js module specifier.
paths	string | Array.<string>	One or more additional directories from which to resolve the supplied specifier from.

loadModuleRelativeTo(specifier, paths)

Kind: exported function

Param	Type	Description
specifier	string	A valid module path.
paths	string | Array.<string>	One or more additional directories in which to search for the supplied module path.

---

© 2017-24 Lloyd Brookes <[e-mail]>.

Tested by test-runner. Documented by jsdoc-to-markdown.