188c0968e1
Add Troubleshooting documentation ( #921 )
...
* Move Common Problems wiki documentation to troubleshooting.md
* Fix header levels and TOC linking
* Change header structure, move causes to their own sections
* Fix fragment capitalization
* Add an example for missing await
* Cleanup language due to problem generalization
* Add visibility for troubleshooting
* Fix fragment typo
2017-03-01 15:50:02 -08:00
0c28d1f57b
Fix async/await babel recommendation
2017-02-26 12:23:42 -06:00
909b829ac6
Fix typo
2017-02-26 12:23:11 -06:00
d4b32234ea
docs++
2017-02-25 00:30:11 -06:00
df7b4ff2b8
docs: replace the reference to co
...
closes #893
2017-02-24 23:43:26 -06:00
00156dfec6
remove unused app.name ( #899 )
2017-02-18 14:01:58 -08:00
152b6d73b7
Fix response.status default value documentation ( #889 )
...
Resolves #888 , also see #705
2017-02-18 13:57:45 -08:00
fabf5864c6
Amend typo, request.is() return null|fasle|string. ( #864 )
...
Modifying the test for `null` from `==` to `===` to make sure it must be `null`.
2016-12-01 18:16:02 +08:00
e3ccdac621
Clarify behavior of ctx.throw in docs ( #856 )
2016-11-25 11:51:02 +08:00
614b4e1ad7
`yield` => `await` ( #798 )
2016-08-21 21:21:09 -07:00
2c507d335d
fix typo ( #756 )
2016-06-21 20:01:51 -07:00
b16d24ecb8
add maxAge and overwrite options to ctx.cookies.set(name, value, [options]). ( #742 )
2016-05-26 13:31:11 +08:00
e61d54565b
docs: add more docs about app.context
...
references:
- https://github.com/koajs/koa/issues/652
2016-05-14 08:36:50 -07:00
808768a597
copy tweaks ( #731 )
2016-05-13 14:27:18 +08:00
e0a0d9f7cc
fix: v1 artifact "this" reference ( #711 )
2016-04-20 14:15:11 +08:00
fd839976e2
Typo
...
Significant, but insignificant. Feel free to discard this pull request and make the change yourselves :)
2016-04-03 08:41:04 +08:00
9c6969755f
Correct ctx.assert documentation parameter order
2016-03-26 21:26:09 -06:00
efcdd3b93e
Docs: v2 error handling is environment independent
2016-03-22 12:22:43 -06:00
2b094eb895
docs: update history and docs for v2
2016-03-22 11:03:19 -07:00
340dd4f1a3
Lint JavaScript in Markdown
2016-03-16 16:50:10 +01:00
1d1698eb85
Update error handling doc to use promises+async
2016-03-12 20:19:55 -07:00
a440425dc2
Add support for headers in errors
2016-03-12 17:46:35 -07:00
d768ed83b6
docs: note stream error handling and destruction. ref: #612
2016-03-12 14:22:28 -08:00
a808671340
add app.silent, err.status, err.expose to doc, fixes #630
2016-03-12 14:20:46 -08:00
6a147726bd
Add support for flushing headers
2016-03-03 21:01:56 -07:00
1e38b13a94
docs: update docs for koa v2
...
update readme and request, response toJSON method
update readme
update readme
update readme
update readme
update readme
update readme
update docs
update doc
pretty readme
update docs
fix then callback
2016-01-17 16:05:49 -08:00
a09000357d
add docs for babel
2015-11-06 09:45:53 -08:00
4b5ef85f29
correct a spelling error : appropriately
2015-11-05 10:13:07 +08:00
dce805b0ad
Fix typo in example for Koa instantiation
...
need a capital Koa constant
2015-10-24 12:35:08 -07:00
863fce310b
Update docs - add template strings and arrow functions where applicable
2015-10-24 14:01:53 +02:00
b6b0d02df9
update docs
2015-10-24 17:21:47 +08:00
3045b283fd
Fixed typo in docs/api/index.md
2015-10-13 16:09:01 -04:00
93ade5e2dd
refactor Application into a class
2015-10-13 01:19:42 -05:00
b2bcbcec7c
docs: add request.origin
2015-10-03 11:38:48 +08:00
e710b4b05f
add app.context docs
2015-08-30 22:20:53 -05:00
05b5912912
Clarify precondition for freshness check
...
I ran into the issue from #294 and thought it was a bug since fresh was always returning false. I think it's fair that, at the very least, the docs are not completely clear on how to use `this.fresh`.
2015-07-16 00:37:41 -07:00
915fa54bab
docs: remove performance diff between express
...
closes #442
2015-05-23 20:07:53 -07:00
34c36d05c3
Merge pull request #436 from soygul/patch-1
...
Update doc example to use ctx.state
2015-04-24 01:13:00 +08:00
1c5cb6f691
feat: alias response.headers to response.header
2015-04-23 17:28:31 +08:00
d5b73ebe4f
update doc example to use ctx.state
2015-04-16 15:43:45 +02:00
963d46e46b
bump supported iojs/node versions
2015-02-01 16:35:17 -08:00
5a3f32dfdd
Add res.append(field, val) to append headers
2015-01-26 02:20:08 +08:00
6cb5a9b9b8
n 0.11
2014-12-30 11:47:36 -08:00
3e66157472
ctx.request.href: get full request url, include `protocol`, `host` and `originalUrl`
...
Useful on those scenes need current full request url, like `OAuth`.
2014-12-27 14:17:00 -08:00
6d09053dac
Update response.md
2014-12-04 15:14:05 -08:00
6847fe68bd
added: ctx.state as the recommended namespace for passing information through middleware and routes.
2014-11-18 00:54:14 -08:00
d0586bae30
docs: fix content negotiation section indentation
2014-10-12 17:00:02 +08:00
30967f57ec
docs: fix content negotiation section indentation
2014-10-09 09:11:09 -07:00
efdd7d3716
less strict for status, close #350
...
add res.message[=]
2014-10-09 23:20:53 +08:00
cc4a549b70
fixed typo in documentation
2014-09-27 17:38:21 +05:30
17e98e4e7d
updated request.md and response.md
2014-09-25 17:06:23 +05:30
85da935759
add .assert() docs
2014-09-20 13:19:07 -07:00
dc0c35471c
support errors and update docs
2014-08-12 13:22:33 -07:00
a85889e6c6
docs: add ctx.headers alias
2014-08-09 13:39:36 +08:00
f84bf23169
add docs for .throw() properties
2014-08-08 13:31:28 -07:00
5ca9f451a7
alias request.headers as request.header
2014-08-07 00:04:21 +08:00
a7b6ed0529
fix middleware gif, close #322
2014-08-04 11:28:14 +08:00
a437329f79
Fix misspelled word from "backwords" to "backwards"
2014-06-17 12:40:06 -07:00
db0875208d
docs
2014-06-13 09:02:06 -07:00
31ba115231
res: add .is()
2014-06-13 00:30:59 -07:00
71536b35be
remove res.statusString
2014-06-10 14:31:41 -07:00
4065bf7e79
docs: discuss custom properties
...
related to #292 . might be placed better somewhere else
2014-06-07 03:45:13 -07:00
fdbd16acc3
remove response.append(), use vary module
2014-06-05 16:06:15 -07:00
21b7eb82b9
add originalUrl
2014-05-06 10:01:46 +08:00
55ebdb522b
docs
2014-05-05 08:44:00 -07:00
50ffb86a40
Merge pull request #278 from dead-horse/host-setter
...
remove req.host=
2014-05-05 08:42:28 -07:00
f76268ba58
remove req.host=, fix docs
2014-05-05 12:45:33 +08:00
d7d3e84d16
Using property properly
2014-05-03 15:21:07 -06:00
212137139a
add installation docs back
...
wtf...
2014-05-01 16:36:16 -07:00
f17629d19f
remove .outputErrors, suppress output when handled by the dev. Closes #272
2014-05-01 16:29:37 -07:00
b7a747fc71
Fix typo in request api documentation.
2014-04-12 00:29:33 +02:00
d92a3c371f
Update index.md
2014-04-12 00:23:11 +02:00
9e8d6a3aa0
ocd
2014-03-24 21:21:15 +03:00
9c2ea5a2a8
Update koa-vs-express.md
2014-03-10 04:20:54 -07:00
bef5bad738
Update context.md
...
ctx.type is delegated to this.response.
2014-03-08 14:19:40 +08:00
0f20b85da5
fix some typos in koa-vs-express docs
2014-03-07 14:11:02 -08:00
b1f0abd16d
Revert "add response.charset accessor and ctx.charset alias"
...
This reverts commit 94413b1bd4
2014-03-06 18:05:01 -08:00
e56f442222
refactor request docs to use this.request
...
maybe we should do this with all of them, but then we might
need a section showing ctx.* stuff, people might miss the aliasing all together
2014-02-14 09:40:58 -08:00
785aba879c
add request.charset
2014-02-14 09:38:59 -08:00
94413b1bd4
add response.charset accessor and ctx.charset alias
2014-02-14 09:33:10 -08:00
c0e0c7c6aa
update docs for previous breaking change
2014-02-14 09:20:29 -08:00
14cdfb7fc4
fix doc, getter of type is delegated to request
...
Same kind of confusing thing as #215 mentioned, user have to remember that getters and setters of the `length` and `type` property are different.
2014-02-14 13:42:04 +08:00
abb5686d5b
docs: add note about confusing context accessors
2014-02-13 18:23:45 -08:00
aa08845c70
remove app.jsonSpaces setting. Closes #202
2014-01-31 18:39:47 -08:00
2bc3bb7327
this.respond=false for bypassing koa's response handling
...
closes #198
2014-01-24 14:38:40 -08:00
7e66aca8c3
better content negotiation docs
...
closes #193
2014-01-18 14:22:53 -08:00
30d200dc09
remove the vary method from request object
2014-01-17 18:19:51 +08:00
420a6154bc
update document
2014-01-17 16:30:35 +08:00
26fb6a138a
add ctx.host= delegate
2014-01-07 17:22:46 -08:00
43a8c12028
docs for req.host=
2014-01-07 17:21:43 -08:00
93351bf845
Add req.host=
2014-01-07 21:09:01 +00:00
bafc0109fc
Update response.md
2014-01-04 12:11:03 -08:00
aa50c8ba7a
docs: update docs on res.status and res.body
2014-01-04 02:05:05 -08:00
26f0d16644
docs: cleanup middleware guide, including TJ's yoda-style conditionals
...
changes on top of 789c30f926#158 , closes #157
2013-12-30 22:20:32 -08:00
789c30f926
adding docs on how to add multiple middleware at once. #157
2013-12-30 22:08:56 -08:00
d9e56b901d
docs: clarify node response property support
2013-12-30 22:08:56 -08:00
7ee4f43dc0
docs: add debugging and ._name docs
2013-12-29 22:16:04 -08:00
e492899443
Fix typo in api/index.md
...
* `negotation` to `negotiation`
2013-12-30 05:06:49 +05:30
c6c375c252
Benchmarks: Table-fy
...
Had to un-indent text for the GFM markdown to accept the table. Not sure what to do with rest of the file, so I'll leave it open.
`benchmark/` probably needs some love if we expect it to generate
similar output. Even without it, I still think the most readable for end-users.
is the best possible result.
2013-12-28 17:07:00 +11:00
3891e1787b
docs: more benchmark stuff
2013-12-26 11:03:47 -08:00
Jeff Moore
Ilkka Oksanen
Stéphane Bisinger
jongleberry
Amit Portnoy
Lee Bousfield
iamchenxin
Malcolm
Ivan Lyons
qingming
Yu Qi
jongleberry
Zack Tanner
d3v
Marceli.no
Robin Pokorný
Jonathan Ong
dead_horse
pana
frank
Kwyn Alice Meagher
Slobodan Stojanovic
Arjun
Tejas Manohar
Travis Jeffery
Matthew King
Teoman Soygul
fengmk2
Guilherme Pacheco
Matthew Mueller
TJ Holowaychuk
Peeyush Kushwaha
bhanuc
Ian Storm Taylor
Jan Carlo Viray
Tim Schaub
Sonny Piers
Dmitry Mazuro
alsotang
Qiming zhao
jeromew
Matthew Chase Whittemore
Debjeet Biswas
Johan Bergström