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

Merge branch 'master' of github.com:koajs/koa

Browse source
This commit is contained in:
TJ Holowaychuk 2013-12-18 20:24:49 -08:00
commit 0ae852be03
1 changed files with 5 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/api/context.md
View file

@ -1,4 +1,3 @@
# Context # Context
A Koa Context encapsulates node's `request` and `response` objects A Koa Context encapsulates node's `request` and `response` objects
@ -96,7 +95,7 @@
- `signed` the cookie requested should be signed - `signed` the cookie requested should be signed
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.cookies.set(name, value, [options]) ### ctx.cookies.set(name, value, [options])
@ -109,13 +108,13 @@
- `secure` secure cookie - `secure` secure cookie
- `httpOnly` server-accessible cookie, __true__ by default - `httpOnly` server-accessible cookie, __true__ by default
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])
Helper method to throw an error with a `.status` property Helper method to throw an error with a `.status` property
that will allow Koa to respond appropriately. The following defaulting to `500` that will allow Koa to respond appropriately.
combinations are allowed: The following combinations are allowed:
```js ```js
this.throw(403) this.throw(403)
@ -135,4 +134,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.