https://github.com/shinnn/import-package
Import an npm package from the disk
https://github.com/shinnn/import-package
fallback import javascript nodejs npm package promise
Last synced: 15 days ago
JSON representation
Import an npm package from the disk
- Host: GitHub
- URL: https://github.com/shinnn/import-package
- Owner: shinnn
- License: isc
- Created: 2018-11-12T23:09:25.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-11-12T23:19:48.000Z (over 7 years ago)
- Last Synced: 2025-03-28T08:11:14.725Z (about 1 year ago)
- Topics: fallback, import, javascript, nodejs, npm, package, promise
- Language: JavaScript
- Size: 21.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# import-package
[](https://www.npmjs.com/package/import-package)
[](https://travis-ci.com/shinnn/import-package)
[](https://coveralls.io/github/shinnn/import-package?branch=master)
Import an [npm package](https://docs.npmjs.com/about-packages-and-modules#about-packages) from the disk
```javascript
const importPackage = require('import-package');
(async () => {
const tar = importPackage('tar');
//=> {create: [Function], update: [Function], extract: [Function], ...}
})();
```
## Installation
[Use](https://docs.npmjs.com/cli/install) [npm](https://docs.npmjs.com/getting-started/what-is-npm).
```
npm install import-package
```
## API
```javascript
const importPackage = require('import-package');
```
### importPackage(*id*)
*id*: `string` (a module ID)
Return: `Promise`
It imports a module with the given module ID from either of the following 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/cli) is installed
If the module ins't installed in CWD but included in the [npm CLI dependencies](https://github.com/npm/cli/tree/v6.4.1/node_modules), it imports the module from npm CLI directory.
```javascript
// $ npm ls npm-packlist
// > └── (empty)
(async () => {
// However, npm CLI contins `npm-packlist` package.
const npmPacklist = await importPackage('npm-packlist'); //=> {[Function: walk], sync: [Function: walkSync], ...}
})();
```
If the module is not included in the npm CLI dependencies but installed in CWD, it imports the module from CWD.
```javascript
// $ npm ls eslint
// > └── eslint@5.9.0
(async () => {
// npm CLI doesn't contain `eslint` package.
const eslint = await importPackage('eslint'); //=> {Linter: [Function: Linter], ...}
})();
```
If the module exists in both directories, it compares their [package versions](https://docs.npmjs.com/files/package.json#version) and imports the newer one.
```javascript
// $ npm ls tar
// > └── tar@0.1.0
(async () => {
// Loaded from the npm CLI directory as the CWD version is older
const tar = await importPackage('tar');
})();
```
The returned `Promise` will be fulfilled with the imported module, or rejected when it fails to find the module.
Each imported modules are stored in the internal cache and they will be loaded faster at the next time on.
### importPackage.preload(*id*)
*id*: `string` (a module ID)
Return: `boolean` (whether the package is already imported or not)
Try to find the given package and store it to the internal cache when it exists.
This method is useful when a user knows which package will be needed and want it to be loaded faster when it's actually imported.
```javascript
const importPackage = require('import-package');
module.exports = function main() {
const uuid = await importPackage('uuid');
return uuid();
}
// The author know `uuid` package needs to be imported in the future.
importPackage.preload('uuid');
```
## License
[ISC License](./LICENSE) © 2018 Shinnosuke Watanabe