# composey

> Simple route module loading for Express with dependency injection

Latest version **1.1.0** (published 2014-11-05) · MIT license · 0 weekly downloads

## Install

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

## 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.1.0 |
| Published | 2014-11-05 |
| First published | 2014-08-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Heartswift |
| Maintainers | scottcorgan |
| Keywords | compose, dependency, injection, express, connect, route |

## Links

- npm: https://www.npmjs.com/package/composey
- Repository: https://github.com/heartswift/composey
- Issues: https://github.com/heartswift/composey/issues
- npm.io page: https://npm.io/package/composey

## Dependencies (2)

- [xtend](https://npm.io/package/xtend.md) ^4.0.0
- [caller-path](https://npm.io/package/caller-path.md) ^0.1.0

## Alternatives

- [express-promise-router](https://npm.io/package/express-promise-router.md) — 736.1K weekly downloads
- [next-usequerystate](https://npm.io/package/next-usequerystate.md) — 29.8K weekly downloads
- [@bitkyc08/opencodex](https://npm.io/package/@bitkyc08/opencodex.md) — 4.6K weekly downloads
- [lynkr](https://npm.io/package/lynkr.md) — 575 weekly downloads
- [baremetal.js](https://npm.io/package/baremetal.js.md) — 42 weekly downloads

## Recent versions

- 1.1.0 (latest) — 2014-11-05
- 1.0.0 — 2014-11-05
- 0.1.2 — 2014-08-15
- 0.1.1 — 2014-08-15
- 0.1.0 — 2014-08-15

## README

# composey ![npm version](http://img.shields.io/npm/v/composey.svg?style=flat-square)  ![MIT license](http://img.shields.io/npm/l/composey.svg?style=flat-square)

Simple route module loading for Express with dependency injection

## Install

```
npm install composey --save
```

## Usage

Compose the route modules

```js
var express = require('express');
var compose = require('composey');

var app = express();

compose({
  app: app,
  routes: {
    './lib/some-module': {
      imports: {
        anotherModule: require('another-module'),
        myModule: require('my-module')
      }
    }
  }
});

app.listen(3000, function () {
  console.log('server started');
});
```

Example module `./lib/some-module`

```js
module.exports = function (imports) {
  var router = imports.Router();
  var anotherModule = imports.anotherModule;
  var myModule = imports.myModule;
  
  router.get('/testing', function (req, res) {
  	res.send('done');
  });
  
  return router;
};
```

## API

### compose(options

* `options`
  * `app` - Express app object. If you don't provide an app object, it creates one for you.
  * `imports` - Default imports to pass to all routes
  * `root` - the root directory to prepend to the path of the modules. Defaults to relative to calling file `__dirname`
  * `routes` - a key/value map of route modules to load. The key is the path to the route module, and the value is another key/value map stating which modules to inject.
  * `mount` - the path the mount the route at. Defaults to `/`
  
## Run Tests

```
npm install
npm test
```

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