TheThing/koa-lite
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

add docs for .throw() properties

Browse source
This commit is contained in:
TJ Holowaychuk 2014-08-08 13:31:28 -07:00
parent 631dd1673c
commit f84bf23169
1 changed files with 11 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
docs/api/context.md
View file

@ -75,17 +75,17 @@ Note: koa uses the [cookies](https://github.com/jed/cookies) module where option
Note: koa uses the [cookies](https://github.com/jed/cookies) module where options are simply passed. Note: koa uses the [cookies](https://github.com/jed/cookies) module where options are simply passed.
### ctx.throw(msg, [status]) ### ctx.throw(msg, [status], [properties])
Helper method to throw an error with a `.status` property Helper method to throw an error with a `.status` property
defaulting to `500` that will allow Koa to respond appropriately. defaulting to `500` that will allow Koa to respond appropriately.
The following combinations are allowed: The following combinations are allowed:
```js ```js
this.throw(403) this.throw(403);
this.throw('name required', 400) this.throw('name required', 400);
this.throw(400, 'name required') this.throw(400, 'name required');
this.throw('something exploded') this.throw('something exploded');
``` ```
For example `this.throw('name required', 400)` is equivalent to: For example `this.throw('name required', 400)` is equivalent to:
@ -102,6 +102,12 @@ throw err;
error messages since you do not want to leak failure error messages since you do not want to leak failure
details. details.
You may optionall pass a `properties` object which is merged into the error as-is, useful for decorating machine-friendly errors which are reported to the requester upstream.
```js
this.throw(401, 'access_denied', { user: user });
```
### ctx.respond ### ctx.respond
To bypass Koa's built-in response handling, you may explicitly set `this.respond = false;`. Use this if you want to write to the raw `res` object instead of letting Koa handle the response for you. To bypass Koa's built-in response handling, you may explicitly set `this.respond = false;`. Use this if you want to write to the raw `res` object instead of letting Koa handle the response for you.