docs: update type and description of IncomingMessage.headers (electron#22522)

NilSet · zcbenz · malept · web-flow · commit 2fa499b68255 · 2020-03-18T11:32:26.000+09:00
* docs: update type and description of IncomingMessage.headers Fixes electron#22521 Updates the docs for IncomingMessage.headers to match the changes made in electron#17517 * Update docs/api/incoming-message.md Co-Authored-By: Mark Lee <malept@users.noreply.github.com> Co-authored-by: Cheng Zhao <zcbenz@electronjs.org> Co-authored-by: Mark Lee <malept@users.noreply.github.com>
diff --git a/docs/api/incoming-message.md b/docs/api/incoming-message.md
@@ -51,12 +51,17 @@ A `String` representing the HTTP status message.
 
 #### `response.headers`
 
-An `Record<string, string[]>` representing the response HTTP headers. The `headers` object is
+A `Record<string, string | string[]>` representing the HTTP response headers. The `headers` object is
 formatted as follows:
 
 * All header names are lowercased.
-* Each header name produces an array-valued property on the headers object.
-* Each header value is pushed into the array associated with its header name.
+* Duplicates of `age`, `authorization`, `content-length`, `content-type`,
+`etag`, `expires`, `from`, `host`, `if-modified-since`, `if-unmodified-since`,
+`last-modified`, `location`, `max-forwards`, `proxy-authorization`, `referer`,
+`retry-after`, `server`, or `user-agent` are discarded.
+* `set-cookie` is always an array. Duplicates are added to the array.
+* For duplicate `cookie` headers, the values are joined together with '; '.
+* For all other headers, the values are joined together with ', '.
 
 #### `response.httpVersion`
 
