Unleash awesomeness. Private packages, team management tools, and powerful integrations. Get started with npm Orgs »

koa-res

3.1.1 • Public • Published

koa-res

Format koa's respond json.

NB: koa@1 -> koa-res@1, koa@2 -> koa-res@2+.

Install

$ npm i koa-res --save

Examples

Error Response

const app = new require('koa')
const genres = require('koa-res')
 
app.use(genres({ debug: true }))
 
app.use(() => {
  hi()
})
 
app.listen(3000)

Output:

GET / -> 500
 
{
  ok: false,
  message: 'hi is not defined',
  stack: 'ReferenceError: hi is not defined\n    at Object.<anonymous> (...)',
  version: '1.0.0',
  now: '2017-10-11T08:47:43.379Z'
}

Normal Response

const app = new require('koa')
const genres = require('koa-res')
 
app.use(genres())
 
app.use((ctx) => {
  ctx.body = {
    username: 'nswbmw',
    gender: 'male'
  }
})
 
app.listen(3000)

Output:

GET / -> 200
 
{
  ok: true,
  data: { username: 'nswbmw', gender: 'male' },
  version: '1.0.0',
  now: '2017-10-11T08:50:12.264Z'
}

Custom fields

const app = new require('koa')
const genres = require('koa-res')
 
app.use(genres({
  custom: (ctx) => {
    return {
      name: 'my-api'
    }
  }
}))
 
app.use((ctx) => {
  ctx.body = 'This is my api'
})
 
app.listen(3000)

Output:

GET / -> 200
 
{
  name: 'my-api',
  ok: true,
  data: 'This is my api',
  version: '1.0.0',
  now: '2017-10-11T08:50:12.264Z'
}

Test

$ npm test

License

MIT

Keywords

install

npm i koa-res

Downloadsweekly downloads

93

version

3.1.1

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability