From c55ef32978f4930afbe3f9ab47a03ec5b35b2d76 Mon Sep 17 00:00:00 2001 From: TJ Holowaychuk Date: Wed, 18 Dec 2013 20:12:12 -0800 Subject: [PATCH] docs: move app.listen() stuff lower --- docs/api/index.md | 34 ++++++++++++++++------------------ 1 file changed, 16 insertions(+), 18 deletions(-) diff --git a/docs/api/index.md b/docs/api/index.md index 6de651b..efa47d1 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -4,7 +4,22 @@ as one or more Koa applications may be mounted together to form larger applications, with a single HTTP server. - The following is a useless Koa application bound to port `3000`: +## Settings + + Application settings are properties on the `app` instance, currently + the following are supported: + + - `app.name` optionally give your application a name + - `app.env` defaulting to the __NODE_ENV__ or "development" + - `app.proxy` when true proxy header fields will be trusted + - `app.subdomainOffset` offset of `.subdomains` to ignore [2] + - `app.jsonSpaces` default JSON response spaces [2] + - `app.outputErrors` output err.stack to stderr [false in "test" environment] + +## app.listen(...) + + 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`: ```js var koa = require('koa'); @@ -32,23 +47,6 @@ http.createServer(app.callback()).listen(3000); http.createServer(app.callback()).listen(3001); ``` -## Settings - - Application settings are properties on the `app` instance, currently - the following are supported: - - - `app.name` optionally give your application a name - - `app.env` defaulting to the __NODE_ENV__ or "development" - - `app.proxy` when true proxy header fields will be trusted - - `app.subdomainOffset` offset of `.subdomains` to ignore [2] - - `app.jsonSpaces` default JSON response spaces [2] - - `app.outputErrors` output err.stack to stderr [false in "test" environment] - -## app.listen(...) - - 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). - ## app.callback() Return a callback function suitable for the `http.createServer()`