Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shinnn/load-request-from-cwd-or-npm
Load `request` module from either CWD or npm CLI directory
https://github.com/shinnn/load-request-from-cwd-or-npm
efficiency javascript nodejs npm promise request
Last synced: 27 days ago
JSON representation
Load `request` module from either CWD or npm CLI directory
- Host: GitHub
- URL: https://github.com/shinnn/load-request-from-cwd-or-npm
- Owner: shinnn
- License: isc
- Created: 2015-12-10T11:31:03.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-10-30T11:51:12.000Z (about 6 years ago)
- Last Synced: 2024-10-13T11:45:59.545Z (about 1 month ago)
- Topics: efficiency, javascript, nodejs, npm, promise, request
- Language: JavaScript
- Size: 72.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# load-request-from-cwd-or-npm
[](https://www.npmjs.com/package/load-request-from-cwd-or-npm)
[](https://travis-ci.org/shinnn/load-request-from-cwd-or-npm)
[](https://ci.appveyor.com/project/ShinnosukeWatanabe/load-request-from-cwd-or-npm/branch/master)
[](https://coveralls.io/github/shinnn/load-request-from-cwd-or-npm)
Load [`request`](https://www.npmjs.com/package/request) module from either CWD or [npm](https://www.npmjs.com/) CLI directory.
## Why?
To keep project dependencies smaller.
```console
$ npm install [email protected]
$ du -sh ./node_modules
5.6M ./node_modules
```
```console
$ npm install [email protected]
$ du -sh ./node_modules
> 300K ./node_modules
```
If `load-request-from-cwd-or-npm` is installed to your project directory, you can use `request` module in your program even though it's not actually installed.
Also we have an option to use one of the [`request` alternatives](https://www.npmjs.com/browse/keyword/request) with smaller file size, but none of them can deal with [a lot of edge cases related to networking and HTTP](https://github.com/request/request/tree/master/tests) as `request` does.
## Installation
[Use](https://docs.npmjs.com/cli/install) [npm](https://docs.npmjs.com/getting-started/what-is-npm).
```
npm install load-request-from-cwd-or-npm
```
## API
```javascript
const loadRequestFromCwdOrNpm = require('load-request-from-cwd-or-npm');
```
### loadRequestFromCwdOrNpm()
Return: `Promise`
It loads [`request`](https://github.com/request/request) module from either of these two directories:
1. [`node_modules`](https://docs.npmjs.com/files/folders#node-modules) in the [current working directory](https://nodejs.org/api/process.html#process_process_cwd)
2. `node_modules` in the directory where [`npm` CLI](https://github.com/npm/npm) [dependencies](https://github.com/npm/npm/blob/v5.6.0/package.json#L36-L131) are installed.
If `request` ins't installed in CWD, it loads `request` from npm CLI directory.
```javascript
// $ npm ls request
// > └── (empty)
(async () => {
const request = await loadRequestFromCwdOrNpm();
//=> {[Function: request] get: [Function], head: [Function], ...}
})();
```
If `request` is installed in CWD, it compares [package versions](https://docs.npmjs.com/files/package.json#version) of the CWD one and the npm dependency one, then loads the newer one.
```javascript
// $ npm ls request
// > └── [email protected]
(async () => {
// Loaded from npm CLI directory because the CWD version is older
const request = await loadRequestFromCwdOrNpm();
})();
```
The returned promise will be [fulfilled](https://promisesaplus.com/#point-26) with `request`, or [rejected](https://promisesaplus.com/#point-30) when it fails to find the module from either directories.
## License
[ISC License](./LICENSE) © 2017 - 2018 Shinnosuke Watanabe