74af96da16* build: update some build dependencies * build: fix eslint issues after updating * build: disable ts check on busted js example * build: update internal types for stricter event handling * restore url.parse behavior * fix typing issues * sigh * build: update easy deps * build: skip woa engines check
104 lines
3.3 KiB
Markdown
104 lines
3.3 KiB
Markdown
## Class: IncomingMessage
|
|
|
|
> Handle responses to HTTP/HTTPS requests.
|
|
|
|
Process: [Main](../glossary.md#main-process), [Utility](../glossary.md#utility-process)<br />
|
|
_This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._
|
|
|
|
`IncomingMessage` implements the [Readable Stream](https://nodejs.org/api/stream.html#stream_readable_streams)
|
|
interface and is therefore an [EventEmitter][event-emitter].
|
|
|
|
### Instance Events
|
|
|
|
#### Event: 'data'
|
|
|
|
Returns:
|
|
|
|
* `chunk` Buffer - 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. Must be placed before 'data' event.
|
|
|
|
#### 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`, 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`
|
|
|
|
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.
|
|
|
|
[event-emitter]: https://nodejs.org/api/events.html#events_class_eventemitter
|
|
|
|
#### `response.rawHeaders`
|
|
|
|
A `string[]` containing the raw HTTP response headers exactly as they were
|
|
received. The keys and values are in the same list. It is not a list of
|
|
tuples. So, the even-numbered offsets are key values, and the odd-numbered
|
|
offsets are the associated values. Header names are not lowercased, and
|
|
duplicates are not merged.
|
|
|
|
```js @ts-type={response:Electron.IncomingMessage}
|
|
// Prints something like:
|
|
//
|
|
// [ 'user-agent',
|
|
// 'this is invalid because there can be only one',
|
|
// 'User-Agent',
|
|
// 'curl/7.22.0',
|
|
// 'Host',
|
|
// '127.0.0.1:8000',
|
|
// 'ACCEPT',
|
|
// '*/*' ]
|
|
console.log(response.rawHeaders)
|
|
```
|