README.zh-CN.md

koa-exception-handler

Customizable koa exception (error) handling middleware

安装

yarn add koa-exception-handler

用法

const Koa = require('koa')
const koaException = require('koa-exception-handler')

const app = new Koa()

app.use(koaException(options))

错误处理逻辑

koa-exception-handler 能够捕获程序中抛出的错误，并根据错误对象的 code 值区分错误的类型。

options

options.errorLogger

自定义 errorLogger 函数。

• Type: function
• Default: console.error

options.production

指定是否是生成环境，它能够控制当服务端发生错误时中间件的行为。

• Type: boolean
• Default: process.env.NODE_ENV !== 'development'

当 options.production 为 false 时，如果服务端发生错误，则执行 options.fallback 函数，而不会响应错误到客户端。当然，你可以在 options.fallback 中实现你期望的行为。

optioins.clientErrorHandler

当客户端发生错误时执行的处理函数。

• Type: function

• Default: undefined

• arguments:

  • ctx Koa context
  • err error - 错误对象

• 例子：

app.use(koaException({
  clientErrorHandler: (ctx, err) => {
    ctx.status = err.code
    ctx.type = 'text/plain; charset=utf-8'
    ctx.body = 'Client error: ' + err.toString()
  }
}))

optioins.serverErrorHandler

在非生产环境下，当服务端发生错误时执行的处理函数

• Type: function
• Default: undefined
• arguments:
  • ctx Koa context
  • err error - 错误对象

用法参考 optioins.clientErrorHandler

optioins.fallback

类似于 optioins.serverErrorHandler，只不过，optioins.fallback 是在生产环境下，当服务端发生错误时执行的处理函数。

• Type: function
• Default: undefined
• arguments:
  • ctx Koa context
  • err error - 错误对象