koa better error handler
v11.0.4
Лучший жесткий пакет для LAD и KOA. Делает
ctx.throwAwesome (лучше всего используется с KOA-404-Handler)
ETIMEOUT и EBADFAMILY ) и отправляет 408 ошибок тайм -аута клиента<ul> с более чем одним сообщениемctx.throw Beautiful Messages (например, ctx.throw(404) выведет красивый объект ошибки)text/html , application/json и типы text ответовnpm install --save koa-better-error-handlerВы, вероятно, должны использовать это в сочетании с KOA-404-Handler!
Пакет экспортирует функцию, которая принимает четыре аргумента (по порядку):
cookiesKey - по умолчанию falselogger - по умолчанию consoleuseCtxLogger - по умолчанию truestringify -по умолчанию в fast-safe-stringify (вы также можете использовать JSON.stringify или другой вариант здесь, если предпочтительнее) Если вы пройдете cookiesKey , то будет добавлена поддержка сессий. Вы всегда должны устанавливать значение этого аргумента, если вы используете файлы cookie и сеансы (например, веб -сервер).
Мы рекомендуем использовать салон для вашего logger , а также вы также должны использовать его промежуточное программное обеспечение, так как она будет автоматически заполнять ctx.logger , чтобы вы могли упростить журналы на основе контекста.
Обратите внимание, что этот пакет поддерживает только koa-generic-session и еще не поддерживает koa-session-store (см. Код в index.js для получения большей информации, приглашаются запросы на привлечение).
Нет поддержки сеансов, файлов cookie или флэш -сообщений:
const errorHandler = require ( 'koa-better-error-handler' ) ;
const Koa = require ( 'koa' ) ;
const Router = require ( 'koa-router' ) ;
const koa404Handler = require ( 'koa-404-handler' ) ;
// initialize our app
const app = new Koa ( ) ;
// override koa's undocumented error handler
app . context . onerror = errorHandler ( ) ;
// specify that this is our api
app . context . api = true ;
// use koa-404-handler
app . use ( koa404Handler ) ;
// set up some routes
const router = new Router ( ) ;
// throw an error anywhere you want!
router . get ( '/404' , ctx => ctx . throw ( 404 ) ) ;
router . get ( '/500' , ctx => ctx . throw ( 500 ) ) ;
// initialize routes on the app
app . use ( router . routes ( ) ) ;
// start the server
app . listen ( 3000 ) ;
console . log ( 'listening on port 3000' ) ;Встроенная поддержка сеансов, файлов cookie и флэш-сообщений:
const errorHandler = require ( 'koa-better-error-handler' ) ;
const Koa = require ( 'koa' ) ;
const redis = require ( 'redis' ) ;
const RedisStore = require ( 'koa-redis' ) ;
const session = require ( 'koa-generic-session' ) ;
const flash = require ( 'koa-connect-flash' ) ;
const convert = require ( 'koa-convert' ) ;
const Router = require ( 'koa-router' ) ;
const koa404Handler = require ( 'koa-404-handler' ) ;
// initialize our app
const app = new Koa ( ) ;
// define keys used for signing cookies
app . keys = [ 'foo' , 'bar' ] ;
// initialize redis store
const redisClient = redis . createClient ( ) ;
redisClient . on ( 'connect' , ( ) => app . emit ( 'log' , 'info' , 'redis connected' ) ) ;
redisClient . on ( 'error' , err => app . emit ( 'error' , err ) ) ;
// define our storage
const redisStore = new RedisStore ( {
client : redisClient
} ) ;
// add sessions to our app
const cookiesKey = 'lad.sid' ;
app . use (
convert (
session ( {
key : cookiesKey ,
store : redisStore
} )
)
) ;
// add support for flash messages (e.g. `req.flash('error', 'Oops!')`)
app . use ( convert ( flash ( ) ) ) ;
// override koa's undocumented error handler
app . context . onerror = errorHandler ( cookiesKey ) ;
// use koa-404-handler
app . use ( koa404Handler ) ;
// set up some routes
const router = new Router ( ) ;
// throw an error anywhere you want!
router . get ( '/404' , ctx => ctx . throw ( 404 ) ) ;
router . get ( '/500' , ctx => ctx . throw ( 500 ) ) ;
// initialize routes on the app
app . use ( router . routes ( ) ) ;
// start the server
app . listen ( 3000 ) ;
console . log ( 'listening on port 3000' ) ; Пример запроса:
curl -H " Accept: application/json " http://localhost/some-page-does-not-existПример ответа:
{
"statusCode" : 404 ,
"error" : " Not Found " ,
"message" : " Not Found "
} По состоянию на v3.0.5 вы можете предотвратить автоматическое перевод ошибки, установив свойство ошибки no_translate , чтобы иметь значение true :
function middleware ( ctx ) {
const err = Boom . badRequest ( 'Uh oh!' ) ;
err . no_translate = true ; // <----
ctx . throw ( err ) ;
} Если вы указываете app.context.api = true или установить ctx.api = true , и если происходит сообщение об ошибке проверки монгуза, которое имеет более одного сообщения (например, несколько полей были недействительными) - то err.message будет соединена запятыми, а вместо <li> .
Поэтому, если вы хотите , чтобы ваши сообщения об ошибках API возвращали списки ошибок HTML для проверки Mongoose, затем установите app.context.api = false , ctx.api = false или просто не установите их перед использованием этого обработчика ошибки.
try {
// trigger manual validation
// (this allows us to have a 400 error code instead of 500)
await company . validate ( ) ;
} catch ( err ) {
ctx . throw ( Boom . badRequest ( err ) ) ;
}С списками ошибок:
{
"statusCode" : 400 ,
"error" : " Bad Request " ,
"message" : " <ul class= " text-left mb-0 " ><li>Path `company_logo` is required.</li><li>Gig description must be 100-300 characters.</li></ul> "
}Без списков ошибок:
{
"statusCode" : 400 ,
"error" : " Bad Request " ,
"message" : " Path `company_logo` is required., Gig description must be 100-300 characters. "
} По умолчанию, если ctx.api является истинной, то HTML-TEXT будет вызван на err.message , тем самым преобразуя всю разметку HTML в формат текста.
Вы также можете указать базовый URI в переменной среды для рендеринга As process.env.ERROR_HANDLER_BASE_URL , например, ERROR_HANDLER_BASE_URL=https://example.com (пропустить сцепку) и любые ссылки на HTML, такие как <a href="/foo/bar/baz">Click here</a> [Click here][1] [1] Ссылка добавлена из https://example.com/foo/bar/baz .
MIT © Ник Боуг
