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

docs: add context example

This commit is contained in:
TJ Holowaychuk 2013-12-18 20:35:38 -08:00
parent 0ae852be03
commit c132b83bc9
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/api/context.md
View File

@ -12,7 +12,16 @@
which would force middlware to re-implement this common functionality. which would force middlware to re-implement this common functionality.
A `Context` is created _per_ request, and is referenced in middleware A `Context` is created _per_ request, and is referenced in middleware
as the receiver, or the `this` identifier. as the receiver, or the `this` identifier, as shown in the following
snippet:
```js
app.use(function *(){
this; // is the Context
this.request; // is a koa Request
this.response; // is a koa Response
});
```
## Request aliases ## Request aliases
@ -113,7 +122,7 @@ Note: koa uses the [cookies](https://github.com/jed/cookies) module where option
### ctx.throw(msg, [status]) ### ctx.throw(msg, [status])
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
@ -134,4 +143,4 @@ throw err;
`err.expose` meaning the messages are appropriate for `err.expose` meaning the messages are appropriate for
client responses, which is typically not the case for client responses, which is typically not the case for
error messages since you do not want to leak failure error messages since you do not want to leak failure
details. details.