https://github.com/bevry-archive/lazy-require

Sponsor this project to keep it maintained, or use Deno instead.
https://github.com/bevry-archive/lazy-require

archived nodejs nodejs-modules

Last synced: about 10 hours ago
JSON representation

Sponsor this project to keep it maintained, or use Deno instead.

• Host: GitHub
• URL: https://github.com/bevry-archive/lazy-require
• Owner: bevry-archive
• License: other
• Created: 2013-06-24T22:29:30.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2023-01-23T06:08:54.000Z (almost 2 years ago)
• Last Synced: 2024-09-18T23:44:21.937Z (about 2 months ago)
• Topics: archived, nodejs, nodejs-modules
• Language: JavaScript
• Homepage:
• Size: 715 KB
• Stars: 17
• Watchers: 1
• Forks: 4
• Open Issues: 26
• Metadata Files:
  • Readme: README.md
  • Changelog: HISTORY.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        


Lazy Require

































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.

## Usage

```javascript

// 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.

Install


npm



Install: npm install --save lazy-require



Import: import * as pkg from ('lazy-require')



Require: const pkg = require('lazy-require')





jspm


``` html

    import * as pkg from '//dev.jspm.io/[email protected]'

```

Editions


This package is published with the following editions:






lazy-require aliases lazy-require/source/index.js





lazy-require/source/index.js is ESNext source code for Node.js with Require for modules



lazy-require/edition-browsers/index.js is ESNext compiled for web browsers with Require for modules



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:



Benjamin Lupton — view contributions



Sponsors


No sponsors yet! Will you be the first?



















Contributors


These amazing people have contributed code to this project:





Benjamin Lupton — view contributions





Rob Loach — view contributions





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

License


Unless stated otherwise all works are:

Copyright © 2013+ Bevry Pty Ltd



and licensed under:

MIT License