diff options
author | Patrik Stutz <patrik.stutz@gmail.com> | 2013-10-17 02:11:19 +0200 |
---|---|---|
committer | Trevor Norris <trev.norris@gmail.com> | 2013-10-16 18:34:52 -0700 |
commit | 54910044b33a6405c72ad085915a55c575c027fc (patch) | |
tree | dc4f42042ba94f509fa018734fd20476dfafd46e /doc | |
parent | 2bc30f239be3e56d642eda38df98c656d55b4d86 (diff) | |
download | node-new-54910044b33a6405c72ad085915a55c575c027fc.tar.gz |
http: add statusMessage
Now the status message can be set via req.statusMessage = 'msg';
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/http.markdown | 18 |
1 files changed, 16 insertions, 2 deletions
diff --git a/doc/api/http.markdown b/doc/api/http.markdown index 444500e0c6..7088ee3ddd 100644 --- a/doc/api/http.markdown +++ b/doc/api/http.markdown @@ -258,11 +258,11 @@ Indicates that the underlying connection was terminated before Sends a HTTP/1.1 100 Continue message to the client, indicating that the request body should be sent. See the ['checkContinue'][] event on `Server`. -### response.writeHead(statusCode, [reasonPhrase], [headers]) +### response.writeHead(statusCode, [statusMessage], [headers]) Sends a response header to the request. The status code is a 3-digit HTTP status code, like `404`. The last argument, `headers`, are the response headers. -Optionally one can give a human-readable `reasonPhrase` as the second +Optionally one can give a human-readable `statusMessage` as the second argument. Example: @@ -313,6 +313,20 @@ Example: After response header was sent to the client, this property indicates the status code which was sent out. +### response.statusMessage + +When using implicit headers (not calling `response.writeHead()` explicitly), this property +controls the status message that will be sent to the client when the headers get +flushed. If this is left as `undefined` then the standard message for the status +code will be used. + +Example: + + response.statusMessage = 'Not found'; + +After response header was sent to the client, this property indicates the +status message which was sent out. + ### response.setHeader(name, value) Sets a single header value for implicit headers. If this header already exists |