Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cweili/koa-router-find-my-way
Router middleware for koa. Based on find-my-way, a crazy fast http radix based router.
https://github.com/cweili/koa-router-find-my-way
find-my-way koa koa-router middleware route router
Last synced: about 2 months ago
JSON representation
Router middleware for koa. Based on find-my-way, a crazy fast http radix based router.
- Host: GitHub
- URL: https://github.com/cweili/koa-router-find-my-way
- Owner: Cweili
- License: mit
- Created: 2019-01-31T03:27:07.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-19T10:58:46.000Z (4 months ago)
- Last Synced: 2024-11-08T03:23:25.182Z (about 2 months ago)
- Topics: find-my-way, koa, koa-router, middleware, route, router
- Language: JavaScript
- Homepage:
- Size: 99.6 KB
- Stars: 12
- Watchers: 3
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# koa-router-find-my-way
[![npm][badge-version]][npm]
[![npm][badge-downloads]][npm]
[![npm][badge-license]][npm]
[![github][badge-issues]][github]
[![build][badge-build]][workflows]
[![coverage][badge-coverage]][coveralls]
Router middleware for [koa][koa]. Based on [find-my-way][find-my-way], a crazy fast http radix based router.
## Installation
### NPM
```
npm install koa-router-find-my-way --save
```
> **Note:** koa-router-find-my-way@5 is based on [find-my-way@5][find-my-way].
>
> Old versions:
> * koa-router-find-my-way@4 => find-my-way@3
> * koa-router-find-my-way@3 => find-my-way@2
> * koa-router-find-my-way@2 => find-my-way@1
## Basic Usage
```js
const koaRouter = require('koa-router-find-my-way');
const app = new Koa();
const router = koaRouter();
router.get('/test/:p', async (ctx, next) => {
const { p } = ctx.params;
ctx.body = {
p,
};
await next();
});
app.use(router.routes());
app.listen(80);
```
## API
### koaRouter([options])
All `options` are passed directly to [find-my-way][find-my-way-api].
### router.on(method, path, ...middlewares[, store])
Register a new route.
```js
router
.on('GET', '/examples', async (ctx, next) => {
// a koa middleware
await next();
}, async (ctx, next) => {
// another koa middleware
ctx.body = 'Hello World!';
})
.on('DELETE', '/examples', (ctx, next) => {
// ...
})
.on(['POST', 'PUT'], '/examples', (ctx, next) => {
// ...
});
```
Last argument, `store` is used to pass an object that you can access later inside the handler function. If needed, store can be updated.
```js
router
.on('GET', '/examples', async (ctx, next) => {
assert.equal(ctx.store, { message: 'hello world' });
}, { message: 'hello world' });
```
### router.get|put|post|delete|head|patch|options|all(path, ...middlewares[, store])
If you want an even nicer api, you can also use the shorthand methods to declare your routes.
For each HTTP supported method, there's the shorthand method.
If you need a route that supports all methods you can use the `all` api.
```js
router
.get('/', (ctx, next) => {
ctx.body = 'Hello World!';
})
.post('/users', (ctx, next) => {
// ...
})
.put('/users/:id', (ctx, next) => {
// ...
})
.delete('/users/:id', (ctx, next) => {
// ...
})
.all('/users/:id', (ctx, next) => {
// ...
});
```
### router.routes()
Returns router middleware which dispatches a route matching the request.
### router.off(method, path)
Deregister a route.
```js
router.off('GET', '/example');
```
### router.reset()
Empty router.
```js
router.reset();
```
### router.find(method, path)
Return (if present) the route registered in *method:path*.
The path must be sanitized, all the parameters and wildcards are decoded automatically.
```js
router.find('GET', '/example')
// => { handler: Function, params: Object, store: Object}
// => null
```
### router.prettyPrint()
Prints the representation of the internal radix tree, useful for debugging.
```js
router
.get('/test', () => {})
.get('/test/hello', () => {})
.get('/hello/world', () => {});
console.log(router.prettyPrint());
// └── /
// ├── test (GET)
// │ └── /hello (GET)
// └── hello/world (GET)
```
[npm]: https://www.npmjs.com/package/koa-router-find-my-way
[badge-version]: https://img.shields.io/npm/v/koa-router-find-my-way.svg
[badge-downloads]: https://img.shields.io/npm/dt/koa-router-find-my-way.svg
[badge-license]: https://img.shields.io/npm/l/koa-router-find-my-way.svg
[github]: https://github.com/Cweili/koa-router-find-my-way
[badge-issues]: https://img.shields.io/github/issues/Cweili/koa-router-find-my-way.svg
[workflows]: https://github.com/Cweili/koa-router-find-my-way/actions/workflows/ci.yml?query=branch%3Amaster
[badge-build]: https://img.shields.io/github/workflow/status/Cweili/koa-router-find-my-way/ci/master
[coveralls]: https://coveralls.io/github/Cweili/koa-router-find-my-way?branch=master
[badge-coverage]: https://img.shields.io/coveralls/github/Cweili/koa-router-find-my-way/master.svg
[koa]: https://github.com/koajs/koa
[find-my-way]: https://github.com/delvedor/find-my-way
[find-my-way-api]: https://github.com/delvedor/find-my-way#api