Commit Graph

228 Commits

Author SHA1 Message Date
Igor Adamenko b7fc526ea4 docs: fix typo in cookie path default value docs (#1340) 2019-06-10 14:49:53 +08:00
Dobes Vandermeer 132c9ee63f docs: Clarify the format of request.headers (#1325) 2019-06-03 15:58:02 +08:00
Andrew Peterson 5810f279a4 docs: Removed Document in Progress note in Koa vs Express (#1336)
closes #1335
2019-06-03 15:57:14 +08:00
rosald 130e363856 docs: use 'fs-extra' instead of 'fs-promise' (#1309) 2019-02-14 13:17:35 +08:00
Francisco Ryan Tolmasky I b25e79dfb5 Mark two examples as live for the corresponding documentation change in https://github.com/koajs/koajs.com/pull/38. (#1031)
Reviewed by @tolmasky.
2019-01-06 01:51:55 -06:00
Douglas Wade 48993ade9b docs: Document other body types (#1285) 2018-12-12 12:33:36 +08:00
Douglas Wade a007198fa2 docs: Document ctx.app.emit (#1284) 2018-12-07 15:28:23 +08:00
Douglas Wade f90e825da9 docs: response.set(fields) won't overwrites previous header fields(#1282) 2018-12-07 15:24:51 +08:00
ZYSzys 325792aee9 docs: add table of contents for guide.md (#1267) 2018-11-10 01:42:08 +08:00
Waleed Ashraf 88b92b4315 doc: updated docs for throw() to pass status as first param. (#1268) 2018-11-01 19:17:16 +08:00
小雷 9146024e10 feat: response.attachment append a parameter: options from contentDisposition (#1240) 2018-10-08 22:43:11 +08:00
urugator d32623baa7 docs: Update error-handling.md (#1239)
Docs incorrectly states that exposed errors are being logged by default error listener:
"which simply log the error if error.expose is true"
https://github.com/koajs/koa/blob/master/lib/application.js#L185
2018-09-20 18:43:23 +08:00
Clayton Ray 2180839eda docs: Update koa-vs-express.md (#1230) 2018-08-09 15:39:23 +08:00
Asiel Leal cde0bb10e9 docs: fix grammar 2018-07-01 01:30:22 +08:00
Jason Macgowan 4d42500e76 docs: better demonstrate middleware flow (#1195) 2018-06-06 14:52:20 +08:00
Anton Harniakou 0698d67fef Update guide.md (#1150) 2018-02-16 11:56:51 -08:00
Paul Anderson a64e4ae982 docs: small grammatical fix in api docs index (#1111) 2018-01-30 21:05:49 -08:00
Tomas Ruud e5db6a9833 docs: fixed typo (#1112) 2018-01-30 21:05:19 -08:00
Mengdi Gao c2615ecc5c docs: capitalize K in word koa (#1126) 2018-01-30 21:05:00 -08:00
Taehwan, No 1e81ea3691 docs: update babel setup (#1077) 2017-10-18 03:22:26 -05:00
Pedro Pablo Aste Kompen 0168fd87a8 docs: Update middleware.gif (#1052) 2017-09-25 23:22:22 -05:00
Hrvoje Šimić f3ede44ffa docs: fix dead link to logo image (#1069) 2017-09-25 23:00:15 -05:00
Todor Stoychev 09f1b7bb1f docs: fix typo (#1058) 2017-09-13 12:58:43 -05:00
Usman Hussain 392e8aa90d Koa routing (third party libraries support) (#1038) 2017-08-17 10:20:57 -07:00
Rico Sta. Cruz 7294eae078 koa-vs-express: Update note about generators (#1015) 2017-07-20 18:02:17 -07:00
Saad Quadri 40a6dd2c80 docs: improve consistency in api code examples (#1029) 2017-07-20 18:01:03 -07:00
Hartley Melamed 0c44c11ce3 Updates documentation to include reference for RFC2324 (HTTP Status 418) (#1028) 2017-07-19 11:04:59 -07:00
haoxin 9f2182dec7 docs: fix typo (#1023) 2017-07-13 10:52:07 -07:00
Chiahao Lin 87cde82399 docs: modified examples using the wrong keyword (yield -> await) (#1021) 2017-07-07 00:48:31 -07:00
Martin Iwanowski 327b65cb6b Use node 7+ WHATWG parser for hostname, fixes #1002 (#1004)
* Use node 7+ WHATWG parser for hostname, fixes #1002

* only use URL if host is IPv6, expose parsed URL

* catch invalid URLs, memoize empty obj

* hostname returns empty string when URL throws
2017-06-20 09:57:30 -07:00
Martin fl0w Iwanowski 012587889d added setters for header and headers, fixes #991 2017-06-20 09:57:07 -07:00
designgrill beec26ebf8 docs: A middleware is always responsible for calling downstream (#978)
Irrespective of whether it is called by an upstream middleware or not.
2017-06-12 11:38:25 -07:00
Kareem Kwong 0a7856ca15 docs: Add note about overwriting charset in response.type (#993) 2017-06-12 11:37:16 -07:00
Richard Marmorstein 7941fb5221 grammar (#994) 2017-06-12 11:36:19 -07:00
Equim 08eb1a20c3 docs: apply `Date.now()` to all docs (#988) 2017-05-21 23:33:25 +08:00
Shaun Warman 302814e7a3 docs: Fix minor nitpick in documentation (#987) 2017-05-21 13:40:08 +08:00
Francisco Presencia 3bbb74b3ee docs: added note about arrays (#964)
Added note about arrays being returned as JSON.
2017-04-23 16:17:48 -07:00
Remek Ambroziak 7f3d0765d7 docs: fix documentation to match new http-errors API (#957) (#967) 2017-04-21 21:49:06 +08:00
George Chung cd5d6a1c37 docs: reorganize "response.status=" section (#966)
Reference: https://github.com/jshttp/statuses/blob/v1.2.0/src/iana.json
Since koa@2.2.0 depends statuses@1.2.0
2017-04-21 15:50:39 +08:00
Michał Gołębiowski 682d7b484a docs: add the missing next param (#942) 2017-03-20 01:02:21 +08:00
jongleberry e812339033 docs: create v2 Migration document (#931)
* Give v2 migration documentation its own document. Incorporate docs from #533

* Fix mis-capitalization of Koa

* Remove unnecessary Dependency section

* Hint at koa-convert enabled compatibility

* Add section on constructing with new

* Clarify es6 constructors are used

* Fix varying capitalization

* Restore mistakenly removed Dependency changes section

* v1.x should not receive feature updates

* Add next() to signature, add missing backticks

* docs++
2017-03-07 22:59:42 -08:00
Jeff Moore 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
Ilkka Oksanen 0c28d1f57b Fix async/await babel recommendation 2017-02-26 12:23:42 -06:00
Stéphane Bisinger 909b829ac6 Fix typo 2017-02-26 12:23:11 -06:00
jongleberry d4b32234ea docs++ 2017-02-25 00:30:11 -06:00
jongleberry df7b4ff2b8 docs: replace the reference to co
closes #893
2017-02-24 23:43:26 -06:00
Amit Portnoy 00156dfec6 remove unused app.name (#899) 2017-02-18 14:01:58 -08:00
Lee Bousfield 152b6d73b7 Fix response.status default value documentation (#889)
Resolves #888, also see #705
2017-02-18 13:57:45 -08:00
iamchenxin 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
Malcolm e3ccdac621 Clarify behavior of ctx.throw in docs (#856) 2016-11-25 11:51:02 +08:00