Important: This is the documentation for the upcoming Feathers v5 (Dove). See docs.feathersjs.com for the current version.

# Koa

npm version (opens new window) Changelog (opens new window)

npm install @feathersjs/koa --save

The @feathersjs/koa module contains the KoaJS (opens new window) framework integrations for Feathers. It will turn the Feathers app into a fully compatible KoaJS application.

# koa(app)

koa(app) -> app is a function that turns a Feathers application into a fully KoaJS compatible application that additionally to Feathers functionality also lets you use the KoaJS API (opens new window).

const feathers = require('@feathersjs/feathers');
const { koa, errorHandler, bodyParser, rest } = require('@feathersjs/koa');

// Create an app that is a Feathers AND Express application
const app = koa(feathers());

app.use(errorHandler());
app.use(authentication());
app.use(bodyParser());
app.use(rest());

@feathersjs/koa also exposes the following middleware:

  • rest - A middleware to expose services as REST APIs
  • authentication - A middleware for parsing HTTP headers for Feathers authentication information
  • bodyParser - The koa-bodyparser (opens new window) middleware for parsing request bodies
  • errorHandler - A JSON error handler middleware. Should always be registered as the very first middleware.

# koa(app, koaApp)

koa(app, koaApp) -> app allows to extend an existing Koa application with the Feathers application app.

# koa()

If no Feathers application is passed, koa() -> app returns a plain Koa application (new Koa()).

# app.use(location|mw[, service])

app.use(location|mw[, service]) -> app registers either a service object, or a Koa middleware. If a path and service object is passed it will use Feathers registration mechanism, for a middleware function Koa.

// Register a service
app.use('/todos', {
  async get(id) {
    return { id };
  }
});

// Register an Express middleware
app.use(async (ctx, next) => {
  ctx.body = {
    message: 'Hello world from Koa middleware'
  };

  await next();
});

# app.listen(port)

app.listen(port) -> HttpServer will first call Koa app.listen (opens new window) and then internally also call the Feathers app.setup(server).

// Listen on port 3030
const server = await app.listen(3030);

# app.setup(server)

app.setup(server) -> app is usually called internally by app.listen but in the cases described below needs to be called explicitly.

# Middleware

# rest

# errorHandler

# authentication

# bodyParser

Anything unclear or missing? Get help (opens new window) or Edit this page (opens new window)

Last Updated: 6/1/2021, 8:02:02 PM