# require-npm
> Local NPM Module Repository
Latest version **1.4.1** (published 2016-04-02) · ISC license · 0 weekly downloads
## Install
```sh
npm install require-npm
pnpm add require-npm
yarn add require-npm
bun add require-npm
```
## 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 | 1.4.1 |
| Published | 2016-04-02 |
| First published | 2016-03-31 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | LogicsSoldier@gmail.com |
| Maintainers | logicssoldier |
| Keywords | npm, require, cache, storage, module, local, global |
## Links
- npm: https://www.npmjs.com/package/require-npm
- npm.io page: https://npm.io/package/require-npm
## Alternatives
- [memory-cache](https://npm.io/package/memory-cache.md) — 795.0K weekly downloads
- [@httptoolkit/proxy-agent](https://npm.io/package/@httptoolkit/proxy-agent.md) — 11.2K weekly downloads
- [express-cache-controller](https://npm.io/package/express-cache-controller.md) — 5.3K weekly downloads
- [http-cache-middleware](https://npm.io/package/http-cache-middleware.md) — 4.5K weekly downloads
- [cache2](https://npm.io/package/cache2.md) — 1.5K weekly downloads
## Recent versions
- 1.4.1 (latest) — 2016-04-02
- 1.4.0 — 2016-04-02
- 1.3.9 — 2016-04-02
- 1.3.8 — 2016-04-02
- 1.3.7 — 2016-04-02
- 1.3.6 — 2016-04-02
- 1.3.5 — 2016-03-31
- 1.3.4 — 2016-03-31
- 1.3.3 — 2016-03-31
- 1.3.2 — 2016-03-31
- 1.3.1 — 2016-03-31
- 1.3.0 — 2016-03-31
- 1.2.5 — 2016-03-31
- 1.2.4 — 2016-03-31
- 1.2.3 — 2016-03-31
- … 6 more at https://npm.io/package/require-npm/versions
## README
*Windows support coming soon!*
## Purpose
***
**Require NPM** is a lightweight library invented to download, cache, and reuse NPM modules.
It's intended for **Require NPM** to be used in both development and prototyping stages in order to eliminate redundant downloads of *npm modules*, with large codebases, while also improving developer productivity.
**Require NPM** allows you to reference npm modules and their dependencies throughout many projects without creating multiple redudant instances or ever requiring manual downloads.
### Installation
```cli
npm install require-npm --save-dev
```
OR
```cli
npm install -g require-npm-cli
```
## Usage
***
### Downloading and Configuring NPM Libraries
```js
//requireNPM equals {decorate}
//decorate instantiates {local, global, modules} within require
const requireNPM = require('require-npm').decorate(require);
//check system cache, "npm install express", if hasn't been downloaded before with Require NPM.
//no need to run "npm install express"!!
const express = require.local('express'),
app = express();
//"hello world" express
app.get('/', (req,res) res => res.send('hello world'));
app.listen(8080, () => console.log('server started on 8080..');
```
### Using CLI (Comand Line Interface)
From your projects directory run:
```cli
require express
```
#
Then require **express** normally.
```js
const express = require('express');
```
### Simple Express App
```js
const requireNPM = require('require-npm');
//binds methods ['global', 'local']
requireNPM.decorate(require);
//downloads express codebase locally using npm, if they don't already exist, and then links to codebase within 'node_modules'.
//no need to run "npm install express"!!
const express = require.local('express'),
app = express();
app.get('/', (req,res) => res.send(buildView()));
app.listen(8080, () => console.log('server is running on port 8080.'));
function buildView(){
return require.modules().map(moduleName = `${moduleName}`);
}
```
### Getting More Advanced With Our Express App
```js
const requireNPM = require('require-npm');
//binds methods ['global', 'local']
requireNPM.decorate(require);
//downloads express codebase locally using npm, if they don't already exist, and then links to codebase within 'node_modules'.
//no need to run "npm install express"!!
const express = require.local('express'),
app = express(),
port = 8080;
app.get('/', (req, res) =>
res.send(new RnModelView('Require NPM Local Modules:').compiled)
);
function RnModelView(title){
const listView = require.
modules().
map(moduleName => `${moduleName}`).
join('');
this.compiled =
`
${title}
`;
}
app.listen(port, () => console.log(`The local modules you've downloaded are now visible on port ${port}.`));
```
## Documentation
****
#
#### Require NPM (Main Module)
```
const requireNPM = require('require-npm');
```
#
The main module of **requireNPM's main module** is used to decorate the **require** function and retrieve information on directories and settings.
It consists of the following properties:
```js
{ decorate: [Function: decorate],
settings:
{ Library: '/Users//local-node-modules',
LibraryModulePath: '/Users//local-node-modules/node_modules',
ProjectModulePath: '/Users//projects/my cool app/node_modules' }
}
```
#### requireNPM.decorate(obj)
```
requireNPM.decorate(require);
```
#
The **decorate** function is used to transfer the 'local', 'global', and 'modules' functions to an object. It is recommended that you use this **decorator** to transfer these functions to **Node.js's require** function.
It can also be used as follows.
```js
const blank = {};
requireNPM.decorate(blank);
blank.local('express');
blank.global('gulp');
blank.modules().forEach(moduleName => console.log(moduleName));
```
#### require.local(...modules)
```
const express = require.local('express');
```
#
**require.local** downloads and caches any npm module requested. This allows you to reuse that npm module and it's dependencies, throughout all your projects, without redownloading any files.
---
_Source: https://npm.io/package/require-npm · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._