https://github.com/vicanso/koa-mounting
Mounting middleware for koa
https://github.com/vicanso/koa-mounting
Last synced: 25 days ago
JSON representation
Mounting middleware for koa
- Host: GitHub
- URL: https://github.com/vicanso/koa-mounting
- Owner: vicanso
- License: mit
- Created: 2015-12-07T12:23:01.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-10-13T12:37:51.000Z (almost 9 years ago)
- Last Synced: 2025-06-18T11:18:31.667Z (4 months ago)
- Language: JavaScript
- Size: 8.79 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# koa-mounting
[](https://travis-ci.org/vicanso/koa-mounting)
[](https://coveralls.io/r/vicanso/koa-mounting?branch=master)
[](https://www.npmjs.org/package/koa-mounting)
[](https://github.com/vicanso/koa-mounting)
Mount other Koa applications as middleware. The `path` passed to `mount()` is stripped
from the URL temporarily until the stack unwinds. This is useful for creating entire
apps or middleware that will function correctly regardless of which path segment(s)
they should operate on.
## Installation
```js
$ npm install koa-mounting
```
## Examples
View the [./examples](examples) directory for working examples.
### Mounting Applications
Entire applications mounted at specific paths. For example you could mount
a blog application at "/blog", with a router that matches paths such as
"GET /", "GET /posts", and will behave properly for "GET /blog/posts" etc
when mounted.
```js
const mount = require('koa-mounting');
const Koa = require('koa');
// hello
const a = new Koa();
a.use((ctx, next) => {
return next().then(() => {
ctx.body = 'Hello';
});
});
// world
const b = new Koa();
a.use((ctx, next) => {
return next().then(() => {
ctx.body = 'World';
});
});
// app
const app = new Koa();
app.use(mount('/hello', a));
app.use(mount('/world', b));
app.listen(3000);
console.log('listening on port 3000');
```
Try the following requests:
```
$ GET /
Not Found
$ GET /hello
Hello
$ GET /world
World
```
### Mounting Middleware
Mount middleware at specific paths, allowing them to operate independently
of the prefix, as they're not aware of it.
```js
const mount = require('koa-mounting');
const Koa = require('koa');
function hello(ctx, next){
return next().then(() => {
ctx.body = 'Hello';
});
}
function world(ctx, next){
return next().then(() => {
ctx.body = 'World';
});
}
const app = new Koa();
app.use(mount('/hello', hello));
app.use(mount('/world', world));
app.listen(3000);
console.log('listening on port 3000');
```
### Optional Paths
The path argument is optional, defaulting to "/":
```js
app.use(mount(a));
app.use(mount(b));
```
## Debugging
Use the __DEBUG__ environement variable to whitelist
koa-mount debug output:
```
$ DEBUG=koa-mounting node myapp.js &
$ GET /foo/bar/baz
koa-mount enter /foo/bar/baz -> /bar/baz +2s
koa-mount enter /bar/baz -> /baz +0ms
koa-mount enter /baz -> / +0ms
koa-mount leave /baz -> / +1ms
koa-mount leave /bar/baz -> /baz +0ms
koa-mount leave /foo/bar/baz -> /bar/baz +0ms
```
## License
MIT