CODEWITHSUNDEEP
node.js
Kevin
Kevin

Reputation: 23634

response.writeHead and response.end in NodeJs

var https = require('https');
var fs = require('fs');

var options = {
  key: fs.readFileSync('test/fixtures/keys/agent2-key.pem'),
  cert: fs.readFileSync('test/fixtures/keys/agent2-cert.pem')
};

https.createServer(options, function (req, res) {
  res.writeHead(200);
  res.end("hello world\n");
}).listen(8000);
  1. Can anyone explain me why do we call the writeHead and end method in createServer method.
  2. What is the main purpose of options object passed in createServer method.

Upvotes: 42

Views: 112333

Answers (5)

SpeedoThreeSixty
SpeedoThreeSixty

Reputation: 75

The res.writeHead method is for returning a status code to the browser, and the browser will throw an error if it is a client-side status code or server-side status code. The res.end method is to make sure the response isn't returned before it might be ready, in case of nested code or otherwise.

The purpose of the options object is to make sure the page has a valid key and certificate before declaring that the page is encrypted under https.

Upvotes: 0

kunal pal
kunal pal

Reputation: 324

As far as i know if you don't put the response.end() at the end then your web page will go on loading thus the response.end() is used to tell the server that the data has been loaded

Upvotes: 3

Mr.7
Mr.7

Reputation: 2713

response.writeHead(200) sends a response header to the request. The status code is a 3-digit HTTP status code, like 404.

This method must only be called once on a message and it must be called before response.end() is called.

If you call response.write() or response.end() before calling this, the implicit/mutable headers will be calculated and call this function for you.

Upvotes: 4

Gui Imamura
Gui Imamura

Reputation: 722

In your code, the writeHead() is called to write the header of the response, that the application will serve to the client. The end() method both sends the content of the response to the client and signals to the server that the response (header and content) has been sent completely. If you are still going to send anything else, you should call write() method of res response object instead.

The options JSON object is a modifier that you may use, to override the default behaviour of the createServer() method. In your code's case:
+ key: Private key to use for SSL (default is null)
+ cert: Public x509 certificate to use (default is null)

You can find more in this section of the Node.js API doc about the response.writeHead() method.
You can find more in this section of the Node.js API doc about the https.createServer() method.

Upvotes: 21

Frank van Puffelen
Frank van Puffelen

Reputation: 600100

Those calls to writeHead and end are not being done in the createServermethod, but rather in a callback.

It's a bit easier to see if you split out the callback into a separate function:

function handleRequest(req, res) {
  res.writeHead(200);
  res.end("hello world\n");
}

https.createServer(options, handleRequest).listen(8000);

So here we define a handleRequest function and then pass that into the createServer call. Now whenever the node.js server we created receives an incoming request, it will invoke our handleRequest method.

This pattern is very common in JavaScript and is core to node.js' asynchronous event handling.

Upvotes: 46

Related Questions