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

docs app: some copy changes and typo fixes

Browse source
This commit is contained in:
Jonathan Ong 2013-12-18 23:56:26 -08:00
parent 0c024c48a8
commit 2f4163f6e6
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/api/index.md
View file

@ -27,8 +27,8 @@ app.listen(3000);
## Cascading ## Cascading
Koa middleware cascading in a more traditional way as you may be use to with similar tools - Koa middleware cascading in a more traditional way as you may be use to with similar tools -
this was previsouly not impossible, but difficult to make user friendly due to node's callbacks, this was previously very difficult to make user friendly due to node's callbacks.
however with generators we can achieve "true" middlware. Contrasting Connect's implementation which However with generators we can achieve "true" middlware. Contrasting Connect's implementation which
simply passes control through series of functions until one returns, Koa yields "downstream", then simply passes control through series of functions until one returns, Koa yields "downstream", then
control flows back "upstream". control flows back "upstream".
@ -84,9 +84,9 @@ app.listen(3000);
## app.listen(...) ## app.listen(...)
A Koa application is not a 1-to-1 representation of an HTTP server, A Koa application is not a 1-to-1 representation of a HTTP server.
as one or more Koa applications may be mounted together to form larger One or more Koa applications may be mounted together to form larger
applications, with a single HTTP server. applications with a single HTTP server.
Create and return an HTTP server, passing the given arguments to Create and return an HTTP server, passing the given arguments to
`Server#listen()`. These arguments are documented on [nodejs.org](http://nodejs.org/api/http.html#http_server_listen_port_hostname_backlog_callback). The following is a useless Koa application bound to port `3000`: `Server#listen()`. These arguments are documented on [nodejs.org](http://nodejs.org/api/http.html#http_server_listen_port_hostname_backlog_callback). The following is a useless Koa application bound to port `3000`:
@ -106,7 +106,7 @@ var app = koa();
http.createServer(app.callback()).listen(3000); http.createServer(app.callback()).listen(3000);
``` ```
This means you can spin up the same application as both HTTP and HTTPS, This means you can spin up the same application as both HTTP and HTTPS
or on multiple addresses: or on multiple addresses:
```js ```js