Class HttpRequest

Represents a request to a web server from a client

Hierarchy

HttpRequest

Index

Constructors

Properties

body? headers method path

Constructors

constructor

new HttpRequest(method, path, headers?, body?): HttpRequest
Constructor for the HttpRequest class
Parameters
- method: string
  
  The verb to use for the request (i.e. GET, POST, PUT, DELETE, HEAD)
- path: string
  
  The URI of the request
- headers: HttpHeaders = ...
  
  Additional custom headers to send to the server
- Optional body: InputStream
  
  The request body, in the case of a POST or PUT request
Returns HttpRequest

Properties

`Optional` body

body?: InputStream

The request body, in the case of a POST or PUT request

headers

headers: HttpHeaders = ...

Additional custom headers to send to the server

method

method: string

The verb to use for the request (i.e. GET, POST, PUT, DELETE, HEAD)

path

path: string

The URI of the request

Generated using TypeDoc