Header menu logo fable-electron-docs-api

IncomingMessage Type

⚠ Process Availability: Main ✔ | Renderer ❌ | Utility ✔ | Exported ❌

Instance members

Instance member Description

this.headers

Full Usage: this.headers

A Record 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 ', '.

this.httpVersion

Full Usage: this.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.

this.httpVersionMajor

Full Usage: this.httpVersionMajor

An Integer indicating the HTTP protocol major version number.

this.httpVersionMinor

Full Usage: this.httpVersionMinor

An Integer indicating the HTTP protocol minor version number.

this.offAborted handler

Full Usage: this.offAborted handler

Parameters:
    handler : unit -> unit

Modifiers: inline

Emitted when a request has been canceled during an ongoing HTTP transaction.

handler : unit -> unit

this.offData handler

Full Usage: this.offData handler

Parameters:
Modifiers: inline

The data event is the usual method of transferring response data into applicative code.

handler : Buffer -> unit

this.offEnd handler

Full Usage: this.offEnd handler

Parameters:
    handler : unit -> unit

Modifiers: inline

Indicates that response body has ended. Must be placed before 'data' event.

handler : unit -> unit

this.offError handler

Full Usage: this.offError handler

Parameters:
    handler : Error -> unit

Modifiers: inline

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.

handler : Error -> unit

this.onAborted handler

Full Usage: this.onAborted handler

Parameters:
    handler : unit -> unit

Modifiers: inline

Emitted when a request has been canceled during an ongoing HTTP transaction.

handler : unit -> unit

this.onData handler

Full Usage: this.onData handler

Parameters:
Modifiers: inline

The data event is the usual method of transferring response data into applicative code.

handler : Buffer -> unit

this.onEnd handler

Full Usage: this.onEnd handler

Parameters:
    handler : unit -> unit

Modifiers: inline

Indicates that response body has ended. Must be placed before 'data' event.

handler : unit -> unit

this.onError handler

Full Usage: this.onError handler

Parameters:
    handler : Error -> unit

Modifiers: inline

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.

handler : Error -> unit

this.onceAborted handler

Full Usage: this.onceAborted handler

Parameters:
    handler : unit -> unit

Modifiers: inline

Emitted when a request has been canceled during an ongoing HTTP transaction.

handler : unit -> unit

this.onceData handler

Full Usage: this.onceData handler

Parameters:
Modifiers: inline

The data event is the usual method of transferring response data into applicative code.

handler : Buffer -> unit

this.onceEnd handler

Full Usage: this.onceEnd handler

Parameters:
    handler : unit -> unit

Modifiers: inline

Indicates that response body has ended. Must be placed before 'data' event.

handler : unit -> unit

this.onceError handler

Full Usage: this.onceError handler

Parameters:
    handler : Error -> unit

Modifiers: inline

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.

handler : Error -> unit

this.rawHeaders

Full Usage: this.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.

this.statusCode

Full Usage: this.statusCode

An Integer indicating the HTTP response status code.

this.statusMessage

Full Usage: this.statusMessage

A string representing the HTTP status message.

Type something to start searching.