2fa499b682
* docs: update type and description of IncomingMessage.headers Fixes #22521 Updates the docs for IncomingMessage.headers to match the changes made in #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>
2.5 KiB
Class: IncomingMessage
Handle responses to HTTP/HTTPS requests.
Process: Main
IncomingMessage implements the Readable Stream
interface and is therefore an EventEmitter.
Instance Events
Event: 'data'
Returns:
chunkBuffer - A chunk of response body's data.
The data event is the usual method of transferring response data into
applicative code.
Event: 'end'
Indicates that response body has ended.
Event: 'aborted'
Emitted when a request has been canceled during an ongoing HTTP transaction.
Event: 'error'
Returns:
error Error - Typically holds an error string identifying failure root cause.
Emitted when an error was encountered while streaming response data events. For
instance, if the server closes the underlying while the response is still
streaming, an error event will be emitted on the response object and a close
event will subsequently follow on the request object.
Instance Properties
An IncomingMessage instance has the following readable properties:
response.statusCode
An Integer indicating the HTTP response status code.
response.statusMessage
A String representing the HTTP status message.
response.headers
A Record<string, string | string[]> representing the HTTP response headers. The headers object is
formatted as follows:
- All header names are lowercased.
- 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, oruser-agentare discarded. set-cookieis always an array. Duplicates are added to the array.- For duplicate
cookieheaders, the values are joined together with '; '. - For all other headers, the values are joined together with ', '.
response.httpVersion
A String indicating the HTTP protocol version number. Typical values are '1.0'
or '1.1'. Additionally httpVersionMajor and httpVersionMinor are two
Integer-valued readable properties that return respectively the HTTP major and
minor version numbers.
response.httpVersionMajor
An Integer indicating the HTTP protocol major version number.
response.httpVersionMinor
An Integer indicating the HTTP protocol minor version number.