diff options
Diffstat (limited to 'doc/api/synopsis.md')
-rw-r--r-- | doc/api/synopsis.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/doc/api/synopsis.md b/doc/api/synopsis.md new file mode 100644 index 00000000000..7dd3b8fe99d --- /dev/null +++ b/doc/api/synopsis.md @@ -0,0 +1,29 @@ +# Synopsis + +<!--type=misc--> + +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); + +console.log('Server running at http://127.0.0.1:8124/'); +``` + +To run the server, put the code into a file called `example.js` and execute +it with the node program + +``` +$ node example.js +Server running at http://127.0.0.1:8124/ +``` + +All of the examples in the documentation can be run similarly. + +[web server]: http.html |