Interface HttpRequest

An interface describing an HTTP request to be sent.

Hierarchy

HttpRequest

Index

Methods

header queryParam queryParams send

Methods

header

header(name, value): HttpRequest
Sets a header.
Parameters
- name: string
  
  The name for the header.
- value: string
  
  The value for the header.
Returns HttpRequest
This HTTP request object.

queryParam

queryParam(name, value?): HttpRequest
Adds a query parameter. Should do nothing if the value is undefined.
Parameters
- name: string
  
  The name for the query parameter.
- Optional value: string | number | boolean
  
  The value for the query parameter.
Returns HttpRequest
This HTTP request object.

queryParams

queryParams(name, values?): HttpRequest
Adds several query parameters with the same name. Should do nothing if the value is undefined.
Parameters
- name: string
  
  The name for each of the query parameters.
- Optional values: string[] | number[] | boolean[]
  
  The values for the query parameters.
Returns HttpRequest
This HTTP request object.

send

send(): Promise<HttpResponse>
Sends the HTTP request.

Returns Promise<HttpResponse>
A promise that contains the HTTP response.