@eggjs/onerror

@eggjs/onerror

Default error handling plugin for egg.

Usage

onerror plugin is enabled by default in egg. But you still can configure its properties to fits your scenarios.

• errorPageUrl: String or Function - If user request html pages in production environment and unexpected error happened, it will redirect user to errorPageUrl.
• accepts: Function - detect user's request accept json or html.
• all: Function - customize error handler, if all present, negotiation will be ignored.
• html: Function - customize html error handler.
• text: Function - customize text error handler.
• json: Function - customize json error handler.
• js: Function - customize JSONP error handler.

// config/config.default.ts
import { defineConfig } from 'egg';

export default defineConfig({
  onerror: {
    // errorPageUrl support function
    errorPageUrl: (err, ctx) => ctx.errorPageUrl || '/500',
  },
});

// an accept detect function that mark all request with `x-requested-with=XMLHttpRequest` header accepts json.
function accepts(ctx) {
  if (ctx.get('x-requested-with') === 'XMLHttpRequest') return 'json';
  return 'html';
}

Questions & Suggestions

Please open an issue here.

License

MIT

Contributors

Made with contributors-img.