koa better error handler
v11.0.4
منظم الأخطاء الأفضل لـ LAD و KOA. يجعل
ctx.throwرائع (أفضل استخدام مع KOA-404 معالج)
ETIMEOUT و EBADFAMILY ) ويرسل 408 خطأ في مهلة العميل<ul> لأخطاء التحقق من صحة Mongoose مع أكثر من رسالةctx.throw رسائل جميلة (على سبيل المثال ctx.throw(404) ستخرج كائن خطأ جميل)text/html ، application/json ، وأنواع الاستجابة textnpm install --save koa-better-error-handlerربما يجب أن تستخدم هذا بالاشتراك مع KOA-404 معالج أيضا!
تصدر الحزمة وظيفة تقبل أربع وسيطات (بالترتيب):
cookiesKey - الافتراضات إلى falselogger - الافتراضيات إلى consoleuseCtxLogger - الافتراضيات إلى truestringify الإعدادات الافتراضية fast-safe-stringify (يمكنك أيضًا استخدام JSON.stringify أو خيار آخر هنا إذا كان مفضلًا) إذا قمت بتمرير cookiesKey ، فسيتم إضافة دعم للجلسات. يجب عليك دائمًا تعيين قيمة هذه الوسيطة إذا كنت تستخدم ملفات تعريف الارتباط والجلسات (مثل خادم الويب).
نوصي باستخدام المقصورة logger الخاص بك ، ويجب عليك أيضًا استخدام الأدوات الوسيطة أيضًا ، حيث ستعمل على تعزيز ctx.logger لتسهيل السجلات القائمة على السياق.
لاحظ أن هذه الحزمة تدعم فقط koa-generic-session ، ولا تدعم بعد koa-session-store (انظر الكود في index.js للحصول على مزيد من البصيرة ، نرحب بطلبات السحب).
لا يوجد دعم للجلسات أو ملفات تعريف الارتباط أو رسائل الفلاش:
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' ) ;دعم مدمج للجلسات وملفات تعريف الارتباط ورسائل الفلاش:
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 ، وإذا حدثت رسالة خطأ في التحقق من صحة mongoose تحتوي على أكثر من رسالة (على سبيل المثال كانت الحقول المتعددة غير صالحة) - فسيتم ربط 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-to-text على err.message ، وبالتالي تحويل جميع علامة HTML إلى تنسيق نص.
يمكنك أيضًا تحديد URI قاعدة [Click here][1] [1] البيئة <a href="/foo/bar/baz">Click here</a> process.env.ERROR_HANDLER_BASE_URL ERROR_HANDLER_BASE_URL=https://example.com رابط ملحق https://example.com/foo/bar/baz .
MIT © Nick Baugh
