From 739f228f1b7499ae13e7d880d500c393a6665b9c Mon Sep 17 00:00:00 2001 From: Jeremiah Senkpiel Date: Tue, 12 Apr 2016 13:25:03 -0400 Subject: doc: better example & synopsis MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit PR-URL: https://github.com/nodejs/node/pull/6167 Reviewed-By: James M Snell Reviewed-By: Benjamin Gruenbaum Reviewed-By: Robert Jefe Lindstädt --- doc/api/synopsis.md | 30 ++++++++++++++++++++++-------- 1 file changed, 22 insertions(+), 8 deletions(-) (limited to 'doc/api/synopsis.md') diff --git a/doc/api/synopsis.md b/doc/api/synopsis.md index 7dd3b8fe99..134c0dbed7 100644 --- a/doc/api/synopsis.md +++ b/doc/api/synopsis.md @@ -1,29 +1,43 @@ -# Synopsis +# Usage +`node [options] [v8 options] [script.js | -e "script"] [arguments]` + +Please see the [Command Line Options][] document for information about +different options and ways to run scripts with Node. + +## Example + An example of a [web server][] written with Node.js which responds with `'Hello World'`: ```js const http = require('http'); -http.createServer( (request, response) => { - response.writeHead(200, {'Content-Type': 'text/plain'}); - response.end('Hello World\n'); -}).listen(8124); +const hostname = '127.0.0.1'; +const port = 3000; + +const server = http.createServer((req, res) => { + res.statusCode = 200; + res.setHeader('Content-Type', 'text/plain'); + res.end('Hello World\n'); +}); -console.log('Server running at http://127.0.0.1:8124/'); +server.listen(port, hostname, () => { + console.log(`Server running at http://${hostname}:${port}/`); +}); ``` To run the server, put the code into a file called `example.js` and execute -it with the node program +it with Node.js: ``` $ node example.js -Server running at http://127.0.0.1:8124/ +Server running at http://127.0.0.1:3000/ ``` All of the examples in the documentation can be run similarly. +[Command Line Options]: cli.html#cli_command_line_options [web server]: http.html -- cgit v1.2.3