58 lines
1.6 KiB
Markdown
58 lines
1.6 KiB
Markdown
|
# import-lazy [](https://travis-ci.org/sindresorhus/import-lazy)
|
||
|
|
|
||
|
|
> Import a module lazily
|
||
|
|
|
||
|
|
|
||
|
|
## Install
|
||
|
|
|
||
|
|
```
|
||
|
|
$ npm install import-lazy
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```js
|
||
|
|
// Pass in `require` or a custom import function
|
||
|
|
const importLazy = require('import-lazy')(require);
|
||
|
|
const _ = importLazy('lodash');
|
||
|
|
|
||
|
|
// Instead of referring to its exported properties directly…
|
||
|
|
_.isNumber(2);
|
||
|
|
|
||
|
|
// …it's cached on consecutive calls
|
||
|
|
_.isNumber('unicorn');
|
||
|
|
|
||
|
|
// Works out of the box for functions and regular properties
|
||
|
|
const stuff = importLazy('./math-lib');
|
||
|
|
console.log(stuff.sum(1, 2)); // => 3
|
||
|
|
console.log(stuff.PHI); // => 1.618033
|
||
|
|
```
|
||
|
|
|
||
|
|
### Warning: Destructuring will cause it to fetch eagerly
|
||
|
|
|
||
|
|
While you may be tempted to do leverage destructuring, like this:
|
||
|
|
|
||
|
|
```js
|
||
|
|
const {isNumber, isString} = importLazy('lodash');
|
||
|
|
```
|
||
|
|
|
||
|
|
Note that this will cause immediate property access, negating the lazy loading, and is equivalent to:
|
||
|
|
|
||
|
|
```js
|
||
|
|
import {isNumber, isString} from 'lodash';
|
||
|
|
```
|
||
|
|
|
||
|
|
## Related
|
||
|
|
|
||
|
|
- [resolve-from](https://github.com/sindresorhus/resolve-from) - Resolve the path of a module from a given path
|
||
|
|
- [import-from](https://github.com/sindresorhus/import-from) - Import a module from a given path
|
||
|
|
- [resolve-pkg](https://github.com/sindresorhus/resolve-pkg) - Resolve the path of a package regardless of it having an entry point
|
||
|
|
- [lazy-value](https://github.com/sindresorhus/lazy-value) - Create a lazily evaluated value
|
||
|
|
- [define-lazy-prop](https://github.com/sindresorhus/define-lazy-prop) - Define a lazily evaluated property on an object
|
||
|
|
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
MIT © [Sindre Sorhus](https://sindresorhus.com)
|