summaryrefslogtreecommitdiff
path: root/deps/npm/node_modules/update-notifier/node_modules/import-lazy/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'deps/npm/node_modules/update-notifier/node_modules/import-lazy/readme.md')
-rw-r--r--deps/npm/node_modules/update-notifier/node_modules/import-lazy/readme.md64
1 files changed, 64 insertions, 0 deletions
diff --git a/deps/npm/node_modules/update-notifier/node_modules/import-lazy/readme.md b/deps/npm/node_modules/update-notifier/node_modules/import-lazy/readme.md
new file mode 100644
index 0000000000..233e42e23b
--- /dev/null
+++ b/deps/npm/node_modules/update-notifier/node_modules/import-lazy/readme.md
@@ -0,0 +1,64 @@
+# import-lazy [![Build Status](https://travis-ci.org/sindresorhus/import-lazy.svg?branch=master)](https://travis-ci.org/sindresorhus/import-lazy)
+
+> Import modules lazily
+
+
+## Install
+
+```
+$ npm install --save import-lazy
+```
+
+
+## Usage
+
+```js
+// Pass in `require` or a custom import function
+const importLazy = require('import-lazy')(require);
+const _ = importLazy('lodash');
+
+// Where you would normally do
+_.isNumber(2);
+
+// You now instead call it as a function
+_().isNumber(2);
+
+// It's cached on consecutive calls
+_().isString('unicorn');
+
+// Extract lazy variations of the props you need
+const members = importLazy('lodash')('isNumber', 'isString');
+
+// Useful when using destructuring assignment in ES2015
+const {isNumber, isString} = importLazy('lodash')('isNumber', 'isString');
+
+// Works out of the box for functions and regular properties
+const stuff = importLazy('./math-lib')('sum', 'PHI');
+console.log(stuff.sum(1, 2)); // => 3
+console.log(stuff.PHI); // => 1.618033
+```
+
+### Proxy support in Node.js 6 or later
+
+If you use Node.js 6 or later, you can take advantage of ES2015 proxies and don't need to call it as a function.
+
+```js
+const importLazy = require('import-lazy').proxy(require);
+const _ = importLazy('lodash');
+
+// No need to call it as a function but still lazily imported
+_.isNumber(2);
+```
+
+## 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)