koa-reason v0.1.0
#Koa Reason
Using koa-reason for better and easy ok/error returns.
##Why
Koa's this.throw
somehow is not so handy for error-prone returns.
And I also added ok-returns helpers.
##Usage
var koa = require('koa');
var app = koa();
require('koa-reason')(app);
Or in the more verbose way
var koa = require('koa');
var app = koa();
var options = {
ok: {
ok: 'fine'
},
reason: {
error: 'service not available',
reason: 'unknown service error occurred, not one could tell yet'
}
}
require('koa-reason')(app, options);
##Examples
this.ok();
this.ok(200);
this.ok({id:'ABCDEF'});
this.ok({id:'ABCDEF'}, 200);
this.reason();
this.reason(500);
this.reason('not too bad');
this.reason('not too bad', 503);
this.reason({error: 'not too bad', reason: 'I am telling you it is not too bad'});
this.reason({error: 'not too bad', reason: 'I am telling you it is not too bad'}, 503);
##Knowing Issues
Handling with status 204, there should be exactly no output.
##License
The MIT License (MIT)
Copyright (c) 2014 Chilledheart rwindz0@gmail.com
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
10 years ago