/acquire

🧪 Node's require on steroids

Primary LanguageJavaScriptMIT LicenseMIT

npm version npm Build Status JavaScript Style Guide badgen.net license

acquire-module

Node.js' require function on steroids

Installation

$ npm install acquire-module

Features

  • Search for a module in multiple directories
  • Search using both absolute and relative paths
  • You can specify a module prefix as a search option

along with all the existing features of require()

Usage

const acquire = require("acquire-module");

acquire (moduleName, [options])

Parameter Type Description
moduleName <string> The name of the module (if present in node_modules or if paths are specified in option.paths). Can also simply include the module path to resolve.
[options] <Object> Additional search options for moduleName.
[options.paths] <string> , <Array>.string Paths to one or more directories to resolve module location from. For each path specified, both the path itself and node_modules will be searched.
[options.prefix] <string> Prefix of the given moduleName.

• returns a module Object

Examples

> const inquirer = acquire('inquirer')
> var _ = acquire('/core', { prefix: 'lodash' })
> const myModule = acquire('some-file.js', { paths: '.' })
> const anotherModule = acquire('file.js', {paths: './some/place/where/file/exists', prefix: 'some' })
> const nextModule = acquire('app.js', { paths: [ '.', '~/my-modules' ] })
> const doesSomething = acquire('something.js', { paths: [ 'some/place/unsure/where/file/is', '~/my-modules' , '.'] })

© 2019 Abir Bhushan <bhushan.abir@gmail.com>.

© 2017-19 Lloyd Brookes <75pound@gmail.com>.