koa-cbc v0.1.0-unstable

Class-based Controller Middleware for Koa

If you're familiar with Django's class-based views then koa-cbc should feel familiar. It lets you organize different HTTP operations related to a given resource into one class, which is often conceptually and organizationally helpful.

TypeScript Example

(With @types/koa installed)

import Koa, {Context, Next} from "koa";
import BaseController from "koa-cdc";

class UserContoller extends BaseController {
  constructor(ctx: Controller, next?: Next ) {
    super(ctx, next);
  }

  async get() {
    const userId = this.ctx.request.query.id;
    // [...look up user...]
    return user;
  }

  async post() {
    const userData = this.ctx.request.body
    // [...create a new user...]
    return user;
  }
}

const app = new Koa();
app.use((ctx, next) => {new UserController.dispatch(ctx, next)})
.listen(3000);

The single instance of UserController will handle both GET and POST requests.

Installation

# yarn
yarn install koa-cdc

# npm
npm add koa-cdc

TypeScript

koa-cdc is written in TypeScript from the ground up and includes its own type definitions.

Dependencies

If you do plan to use TypeScript, you'll want to include the @types/koa package as a dev dependency for your project:

# yarn
yarn add -D @types/koa
# npm
npm install --save-dev @types/koa

Development

# Clone the repository:
git clone https://github.com/mystery-house/koa-cbc.git

# Install dependencies
yarn install

# Run tests
yarn test

# Build
yarn build

Caveat

This project has not been heavily used yet and will likely undergo multiple changes on its way to a stable release.