Class HttpRequest

Represents an HTTP message with headers and an optional static or streaming body. body: ArrayBuffer | ArrayBufferView | string | Uint8Array | Readable | ReadableStream;

Hierarchy (view full)

HttpRequest
- HttpRequest

Implements

HttpMessage
URI

Index

Constructors

Properties

body? fragment? headers hostname method password? path port? protocol query username?

Methods

clone clone isInstance

Constructors

constructor

new HttpRequest(options): HttpRequest
Parameters
- options: HttpRequestOptions
Returns HttpRequest
Inherited from IHttpRequest.constructor

Properties

`Optional` body

body?: any

`Optional` fragment

fragment?: string

headers

headers: HeaderBag

hostname

hostname: string

method

method: string

`Optional` password

password?: string

path

path: string

`Optional` port

port?: number

protocol

protocol: string

query

query: QueryParameterBag

`Optional` username

username?: string

Methods

clone

clone(): HttpRequest
Returns HttpRequest
Deprecated
use static HttpRequest.clone(request) instead. It's not safe to call this method because HttpRequest.isInstance incorrectly asserts that IHttpRequest (interface) objects are of type HttpRequest (class).

`Static` clone

clone(request): HttpRequest
Note: this does not deep-clone the body.
Parameters
- request: HttpRequest
Returns HttpRequest

`Static` isInstance

isInstance(request): request is HttpRequest
This method only actually asserts that request is the interface IHttpRequest, and not necessarily this concrete class. Left in place for API stability.

Do not call instance methods on the input of this function, and do not assume it has the HttpRequest prototype.
Parameters
- request: unknown
Returns request is HttpRequest