# superimport

> Loads optional node modules from a third part modules folder

Latest version **1.4.1** (published 2021-11-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install superimport
pnpm add superimport
yarn add superimport
bun add superimport
```

## 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 | 2021-11-11 |
| First published | 2016-05-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 11.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Andi Heinkelein |
| Maintainers | andifeind, kippis, firetux |
| Keywords | require, import, load, module, module-loader |

## Links

- npm: https://www.npmjs.com/package/superimport
- Repository: https://github.com/Andifeind/superimport
- Homepage: https://github.com/Andifeind/superimport#readme
- Issues: https://github.com/Andifeind/superimport/issues
- npm.io page: https://npm.io/package/superimport

## Recent versions

- 1.4.1 (latest) — 2021-11-11
- 1.4.0 — 2018-10-07
- 1.3.0 — 2018-05-23
- 1.2.0 — 2018-04-30
- 1.1.0 — 2018-04-06
- 1.0.1 — 2017-09-09
- 1.0.0 — 2017-07-15
- 0.2.0 — 2016-09-19
- 0.1.2 — 2016-07-24
- 0.1.1 — 2016-05-27
- 0.1.0 — 2016-05-26

## README

# superimport

[![Build Status](https://travis-ci.org/Andifeind/superimport.svg?branch=master)](https://travis-ci.org/Andifeind/superimport)

Tries to import a node module from the parent module dir or current working dir.
This was build for the [logtopus](https://github.com/Andifeind/logtopus) logger.
We need a way to load *optional modules* from the `$PROJECT_DIR/node_modules/` dir which is using logtopus, to load optional dependencies.

For example:

The logtopus module should load `logtopus-redis-logger`, but not from its own node_modules directory.
It should be load from `$PROJECT_DIR/node_modules` folder. This gives developers the
opportunity to load *optional dependencies* from the $PROJECT folder.

The logtopus module loads an optional module with `superimport`

```js
// logtopus/index.js
const superimport = require('superimport');
const redisLogger = superimport('logtopus-redis-logger');
```

A third part module uses logtopus and contains the *optional module* as a dependency

```js
// mymodule/example.js
const logtopus = require('logtopus');
```

In this example tries logtopus to require `logtopus-redis-logger` in this order:

1) `mymodule/node_modules/logtopus-redis-logger`  
2) `<cwd>/node_modules/logtopus-redis-logger`  
3) `../node_modules/logtopus-redis-logger` (goes up until `/node_modules`)  
4) return null

And optional second argument overrides the directories which may contain an *optional module*

```js
const dirs = ['../foo/node_modules', '../bar/libs/'];
const mod = superimport('somemodule', dirs);
```


## Methods

### superimport(*str* moduleName [, *arr* importDirs])

See description above

### superimport.importAll(*arr* dir [, *obj* options])

Imports all `.js` or `.node` files from `dir`. The second `options` argument is optional and changes the behaviour. Prior version 1.3.0, the second argument was a boolean and enabled recursive search. This is deprecated now.

##### Options:
| Name          | Default | Description                 |
| ------------- | ------- | --------------------------- |
| `recursive`   | `false` | Includes all subdirectories |
| `silent`      | `false` | Ignore errors               |
| `importTypes` | `false` | Set file extensions to be imported. Uses `require.extensions` to determine the types by default |


Returns an array of all required modules

---
_Source: https://npm.io/package/superimport · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._