# bragg-router

[![Build Status](https://travis-ci.org/SamVerschueren/bragg-router.svg?branch=master)](https://travis-ci.org/SamVerschueren/bragg-router)
[![Coverage Status](https://coveralls.io/repos/github/SamVerschueren/bragg-router/badge.svg?branch=master)](https://coveralls.io/github/SamVerschueren/bragg-router?branch=master)

> Router middleware for [bragg](https://github.com/SamVerschueren/bragg).


## Install

```
$ npm install --save bragg-router
```


## Usage

```js
const app = require('bragg')();
const router = require('bragg-router')();

router.get('/', ctx => {
    ctx.body = 'Home';
});

router.get('/user/{id}', ctx => {
    ctx.body = `Retrieve user with id ${ctx.request.params.id}`;
});

app.use(router.routes());

exports.handler = app.listen();
```

### Multiple handlers

When a handler returns a promise, that promise will be resolved first. The result of following example will be `Foo Bar`.

```js
const app = require('bragg')();
const router = require('bragg-router')();

router.get('/',
	() => Promise.resolve('Foo');
	(ctx, result) => {
		ctx.body = `${result} Bar`;
	}
);

app.use(router.routes());

exports.handler = app.listen();
```


## API

### *verb*(path, ...middlewares)

#### verb

Type: `string`<br>
Values: `get` `post` `put` `delete` `patch` `head` `update`

HTTP-method to listen to.

#### path

Type: `string`

Action of the request. Accepts a [matcher](https://github.com/sindresorhus/matcher) pattern.

#### middlewares

Type: `function`

Functions to be executed the request matches the `path`.

### routes()

Returns a middleware function that can be used by [bragg](https://github.com/SamVerschueren/bragg).


## License

MIT © [Sam Verschueren](https://github.com/SamVerschueren)