Lazy require allows you to require modules lazily, meaning that when you lazy require a missing module, it is automatically installed. If the installation or require fails, the error is returned to the lazy require callback.
JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Lazy Require

Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
Slack community badge Patreon donate button Gratipay donate button Flattr donate button PayPal donate button Bitcoin donate button Wishlist browse button

Lazy require allows you to require modules lazily, meaning that when you lazy require a module that is missing, lazy require will automatically install it for you.

Install

NPM

  • Install: npm install --save lazy-require
  • Module: require('lazy-require')

Browserify

  • Install: npm install --save lazy-require
  • Module: require('lazy-require')
  • CDN URL: //wzrd.in/bundle/lazy-require@2.2.0

Ender

  • Install: ender add lazy-require
  • Module: require('lazy-require')

Editions

This package is published with the following editions:

  • lazy-require aliases lazy-require/index.js which uses Editions to automatically select the correct edition for the consumers environment
  • lazy-require/source/index.js is Source + ESNext + Require
  • lazy-require/es2015/index.js is Babel Compiled + ES2015 + Require

Older environments may need Babel's Polyfill or something similar.

Usage

// Import
var lazyRequire = require('lazy-require')

// Attempt to load the module `ambi`, if it doesn't exist, then try to install it and load it again
// Do this synchronously, only available in Node 0.12 and above
// Passing a callback as the 3rd argument will do this asynchronously, available in all node versions
var ambi = lazyRequire('ambi', {/* options */})
if ( ambi instanceof Error ) {
    // Error ....
    console.log('ambi failed to load because of:', ambi.stack)
} else {
    // Success ...
}

// Attempt to load the module `ambi`, if it doesn't exist, then try to install it and load it again
// Do this synchronously but with a callback, only available in Node 0.12 and above
lazyRequire.sync('ambi', {/* options */}, function(err, ambi){
    // Error ...
    if (err)  return console.log('ambi failed to load because of:', err.stack)

    // Success ...
})

// Attempt to load the module `ambi`, if it doesn't exist, then try to install it and load it again
// Do this asynchronously, available in all node versions
lazyRequire.async('ambi', {/* options */}, function(err, ambi){
    // Error ...
    if (err)  return console.log('ambi failed to load because of:', err.stack)

    // Success ...
})

// Attempt to load the module `ambi`, if it doesn't exist, then try to install it and load it again
// Do this synchronously if supported (Node 0.12 and above), otherwise do it asynchronously
lazyRequire.auto('ambi', {/* options */}, function(err, ambi){
    // Error ...
    if (err)  return console.log('ambi failed to load because of:', err.stack)

    // Success ...
})

The following options are supported:

  • cwd the module path that you would like the requested package to be installed to if it doesn't exist, always recommended
  • save if the requested package doesn't exist, would you like to do a npm --save for it to add it to your cwd's package.json dependencies?

There's some other methods also available to you, for now, read the source to discover them.

History

Discover the release history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

Sponsors

No sponsors yet! Will you be the first?

Patreon donate button Gratipay donate button Flattr donate button PayPal donate button Bitcoin donate button Wishlist browse button

Contributors

These amazing people have contributed code to this project:

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

License

Unless stated otherwise all works are:

and licensed under: