# 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. Latest version **4.6.0** (published 2020-06-20) · MIT license · 0 weekly downloads ## Install ```sh npm install lazy-require pnpm add lazy-require yarn add lazy-require bun add lazy-require ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 4.6.0 | | Published | 2020-06-20 | | First published | 2013-06-24 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Node | >=10 | | Dependencies | 3 | | Unpacked size | 37 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 17 | | Author | 2013+ Bevry Pty Ltd | | Maintainers | balupton, bevryme | | Keywords | browser, dependencies, deps, esnext, lazy, node, optDependencies, optionalDependencies, require | ## Links - npm: https://www.npmjs.com/package/lazy-require - Repository: https://github.com/bevry/lazy-require - Issues: https://github.com/bevry/lazy-require/issues - Funding: https://bevry.me/fund - npm.io page: https://npm.io/package/lazy-require ## Dependencies (3) - [errlop](https://npm.io/package/errlop.md) ^3.7.0 - [safeps](https://npm.io/package/safeps.md) ^10.5.0 - [extract-opts](https://npm.io/package/extract-opts.md) ^4.3.0 ## Alternatives - [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads - [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads - [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads - [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads - [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads ## Recent versions - 4.6.0 (latest) — 2020-06-20 - 4.6.0-next.1593742352.14f59c28dd26de3d9f809e36d42360d24b6bed37 (next) — 2020-07-03 - 4.6.0-next.1592625008.c8b34a2b6ede883d2f6f79cc3037a357c8149d8b — 2020-06-20 - 4.5.0 — 2020-06-10 - 4.5.0-next.1591798235.6f80235c06876d08ab41119f53768eb8d3016b69 — 2020-06-10 - 4.4.0 — 2020-06-10 - 4.4.0-next.1591781122.3492e5078785e2fc363e9c321a5e2f7d48bf736c — 2020-06-10 - 4.3.0 — 2020-05-21 - 4.3.0-next.1590077488.737148f72a18d7af2719a1966a28fbaf27d7b334 — 2020-05-21 - 4.2.0 — 2020-05-21 - 4.2.0-next.1590051062.749035fdfae501719a7f29d61c0af97a44e5e509 — 2020-05-21 - 4.1.0 — 2020-05-20 - 4.1.0-next.1590002218.55161bd01f4d2d87b2f1c87ede80d0462aef28c7 — 2020-05-20 - 4.0.0 — 2020-05-11 - 4.0.0-next.1589158074.b755edf0a64ce40929138266193f5da46b920bfe — 2020-05-11 - … 23 more at https://npm.io/package/lazy-require/versions ## 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 ```

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