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

add ctx.query docs to clarify lack of nested object support

Browse source
This commit is contained in:
TJ Holowaychuk 2013-11-08 15:35:32 -08:00
parent 5bbe362294
commit 22c035bbea
1 changed files with 7 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/api.md
View file

@ -296,7 +296,11 @@ this.type = 'png';
### ctx.query
Get parsed query-string, for example "color=blue&size=small":
Get parsed query-string, returning an empty object when no
query-string is present. Note that this getter does _not_
support nested parsing.
For example "color=blue&size=small":
```js
{
@ -305,11 +309,10 @@ this.type = 'png';
}
```
__NOTE__: this property returns `{}` when no query-string is present.
### ctx.query=
Set query-string to the given object.
Set query-string to the given object. Note that this
setter does _not_ support nested objects.
```js
this.query = { next: '/login' };