koajs/router

Stars
790
Rank 57,622 (Top 2 %)
Language
JavaScript
License
MIT License
Created over 5 years ago
Updated over 1 year ago

koajs/router

koajs

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Router middleware for Koa. Maintained by @forwardemail and @ladjs.

@koa/router

Router middleware for Koa. Maintained by Forward Email and Lad.

Table of Contents

Features
Migrating to 7 / Koa 2
Install
Typescript Support
API Reference
Contributors
License

Features

Express-style routing (app.get, app.put, app.post, etc.)
Named URL parameters
Named routes with URL generation
Match routes with specific host
Responds to OPTIONS requests with allowed methods
Support for 405 Method Not Allowed and 501 Not Implemented
Multiple route middleware
Multiple and nestable routers
async/await support

Migrating to 7 / Koa 2

The API has changed to match the new promise-based middleware signature of koa 2. See the koa 2.x readme for more information.
Middleware is now always run in the order declared by .use() (or .get(), etc.), which matches Express 4 API.

Install

npm install @koa/router

Typescript Support

npm install --save-dev @types/koa__router

API Reference

See API Reference for more documentation.

Contributors

Name
Alex Mingoia
@koajs

License

MIT © Alex Mingoia

koa

Expressive middleware for node.js using ES2017 async functions

examples

Example Koa apps

jwt

Koa middleware for validating JSON Web Tokens

bodyparser

Koa body parsing middleware

static

Static file server middleware

compose

Middleware composition utility

koa-body

koa body parser middleware

session

Simple session middleware for koa

cors

Cross-Origin Resource Sharing(CORS) for koa

kick-off-koa

[MAINTAINERS WANTED] An intro to koa via a set of self-guided workshops

logger

Development style logging middleware

mount

Mount other Koa applications or middleware to a given pathname

ratelimit

Rate limiter middleware

joi-router

Configurable, input and output validated routing for koa

route

Simple route middleware

workshop

Koa Training Workshop

compress

Compress middleware for koa

koa.io

[MAINTAINERS WANTED] Realtime web framework combine koa and socket.io.

send

Transfer static files

generic-session

koa session store with memory, redis or others.

koa-redis

Redis storage for Koa session middleware/cache with Sentinel and Cluster support

koala

[SEEKING MAINTAINER] An HTTP/2 and ES6 Module-ready Koa Suite

static-cache

[MAINTAINERS WANTED] Static cache for koa

csrf

CSRF tokens for koa

react-view

A Koa view engine which renders React components on server

convert

Convert koa generator-based middleware to promise-based middleware

ejs

a koa view render middleware, support all feature of ejs

json

pretty-printed JSON response middleware

todo

a todo example write with koa and react

koa-hbs

Handlebars templates for Koa.js

cash

HTTP response caching for Koa. Supports Redis, in-memory store, and more!

onerror

an error handler for koa, hack ctx.onerror

basic-auth

blanket basic auth middleware

userauth

koa user auth middleware

multer

Middleware for handling `multipart/form-data` for koa, based on Express's multer.

response-time

X-Response-Time middleware

trie-router

Trie-routing for Koa

koa-roles

koa version of Connect-Roles

etag

ETag support for Koa responses

bunyan-logger

Koa middleware for bunyan request logging

favicon

Koa middleware for serving a favicon

error

Error response middleware (text, json, html)

rewrite

URL rewriting middleware

json-filter

Middleware allowing the client to filter the response to only what they need, reducing the amount of traffic over the wire.

json-error

Error handler for pure-JSON apps

qs

qs for koa, and use querystring more safely.

bigpipe-example

[DEPRECATED] BigPipe using koa and component

common

[DEPRECATED] USE INDIVIDUAL MODULES

locales

koa locales, i18n solution for koa

koa-lusca

koa version of lusca. Application security for koa.

cluster

Koa clustering and error handling utility

parameter

parameter validate middleware for koa, powered by parameter

conditional-get

Conditional GET middleware for koa

trace

generic tracing for koa

koa-range

[MAINTAINERS WANTED] range request implementation for koa, see http://tools.ietf.org/html/rfc7233

sendfile

basic file-sending utility for koa

koajs.com

The koajs.com website

mock

Simple web page mock middleware

body-parsers

collection of koa body parsers

koa-markdown

Auto convert markdown to html for koa. Inspired by connect-markdown

koa-gzip

[Deprecated] please use koa-compress instead

file-server

file serving middleware for koa

bundle

Generic asset pipeline with caching, etags, minification, gzipping and sourcemaps.

resourcer

A simple resource directory mounter for koa.

path-match

koa route middleware

html-minifier

minify HTML responses like some crazy guy

webcam-mjpeg-stream

[DEPRECATED] Stream JPEG snapshots from your Mac

timer

time your middleware

statsd

Statsd middleware

redis-session-sets

Koa Redis sessions with field-referencing cross sets

accesslog

Middleware for common log format access logs

is-json

check if a koa body should be interpreted as JSON

charset

use iconv-lite to encode the body and set charset to content-type

koa-safe-jsonp

Safe jsonp plusins for koa.

trace-influxdb

InfluxDB tracing for koa-trace

stateless-csrf

CSRF without sessions.

atomic-session

cross-cookies

Easily set cookies across subdomains

koa-github

simple github auth middleware for koa

s3-cache

Koa middleware to cache and serve from S3

eslint-config-koa

Koa's ESLint config, based on Standard

ctx-cache-control

Augment Koa with ctx.cacheControl(maxAge)

snapshot

take snapshot when request, cache by request path.

compressor

[DEPRECATED] Compress middleware for koa that always compresses

koa-fresh

cdn

[DEPRECATED] middleware for a koa-based CDN

koa-rt

koa rt with microtime

override-method

method override utility for koa

ctx-basic-auth

Augments Koa with ctx.basicAuth

resourcer-docs

[MAINTAINERS WANTED] Simple app that generates documentation for routes mounted using koa-resourcer.

middleware-hook

low-level hooks for your middleware

path

[DEPRECATED] path-matching middleware for koa

observable-redis-session

[DEPRECATED] Observable, atomic sessions for Koa using Redis

help

koa(1) executable for instant help

discussions

KoaJS Discussions