https://github.com/koajs/path-match

koa route middleware
https://github.com/koajs/path-match

Last synced: 2 months ago
JSON representation

koa route middleware

• Host: GitHub
• URL: https://github.com/koajs/path-match
• Owner: koajs
• License: mit
• Created: 2014-07-23T07:34:32.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2024-04-12T01:41:45.000Z (8 months ago)
• Last Synced: 2024-04-14T04:06:44.147Z (8 months ago)
• Language: JavaScript
• Size: 921 KB
• Stars: 34
• Watchers: 5
• Forks: 5
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-koa - path-match - koa route middleware (Middleware)
• awesome-koa - koa-path-match - Koa路由中间件。   (仓库 / 中间件)

README

        

# Koa Path Match

[![NPM version][npm-image]][npm-url]

[![Node.js CI](https://github.com/koajs/path-match/workflows/Node.js%20CI/badge.svg?branch=master)](https://github.com/koajs/path-match/actions?query=workflow%3A%22Node.js+CI%22)

[![Test coverage][codecov-image]][codecov-url]

[![License][license-image]][license-url]

[![Downloads][downloads-image]][downloads-url]

A simple routing wrapper around [path-match](https://github.com/expressjs/path-match).

Similar to [koa-route](https://github.com/koajs/route), except it optionally handles methods better.

All of these routers use [path-to-regexp](https://github.com/component/path-to-regexp)

underneath, which is what Express uses as well.

```js

const route = require('koa-path-match')({/* options passed to path-to-regexp */})

app.use(route('/:id(\\d+)', (ctx, next) => {

  const id = ctx.params.id

  // do stuff

  switch (ctx.request.method) {

  }

}))

```

Or you can create middleware per method:

```js

app.use(route('/:id(\\d+)')

  .get(async ctx => {

    ctx.body = await Things.getById(ctx.params.id)

  })

  .delete(async ctx => {

    await Things.delete(ctx.params.id)

    ctx.status = 204

  })

)

```

## Maintainer

- Lead: @jonathanong [@jongleberry](https://twitter.com/jongleberry)

- Team: @koajs/routing

## API

### route(path, fns...)

`path`s are just like Express routes. `fns` is either a single middleware

or nested arrays of middleware, just like Express.

### const router = route(path)

When you don't set `fns` in the `route()` function, a router instance is returned.

### router\[method\]\(fns...\)

Define a middleware just for a specific method.

```js

app.use(route('/:id(\\d+)').get(async ctx => {

  ctx.body = await Things.getById(ctx.params.id)

}))

```

- `next` is not passed as a parameter.

  I consider this an anti-pattern in Koa - one route/method, one function.

### this.params

Any keys defined in the path will be set to `ctx.params`,

overwriting any already existing keys defined.

[npm-image]: https://img.shields.io/npm/v/koa-path-match.svg?style=flat

[npm-url]: https://npmjs.org/package/koa-path-match

[codecov-image]: https://img.shields.io/codecov/c/github/koajs/path-match/master.svg?style=flat-square

[codecov-url]: https://codecov.io/github/koajs/path-match

[license-image]: http://img.shields.io/npm/l/koa-path-match.svg?style=flat-square

[license-url]: LICENSE

[downloads-image]: http://img.shields.io/npm/dm/koa-path-match.svg?style=flat-square

[downloads-url]: https://npmjs.org/package/koa-path-match