Class HttpRequest

Main object for structuring a request.

Hierarchy

HttpRequest

Index

Constructors

Properties

body headers method timeout uri

Methods

addHeader setBody setHeaders setMethod setTimeout

Constructors

constructor

new HttpRequest(uri): HttpRequest
Parameters
- uri: string
Returns HttpRequest
- Defined in index.d.ts:138

Properties

body

body: string

Content of the body of the HTTP request.

headers

headers: HttpHeader[]

A collection of HTTP headers to add to the outbound request.

method

method: HttpRequestMethod

HTTP method (e.g., GET or PUT or PATCH) to use for making the request.

timeout

timeout: number

Amount of time, in seconds, before the request times out and is abandoned.

uri

uri: string

The HTTP resource to access.

Methods

addHeader

addHeader(key, value): HttpRequest
Parameters
- key: string
- value: string | SecretString
Returns HttpRequest

Remarks
Adds an additional header to the overall list of headers used in the corresponding HTTP request.
- Defined in index.d.ts:137

setBody

setBody(body): HttpRequest
Parameters
- body: string
Returns HttpRequest

Remarks
Updates the content of the body of the HTTP request.
- Defined in index.d.ts:144

setHeaders

setHeaders(headers): HttpRequest
Parameters
- headers: HttpHeader[]
Returns HttpRequest

Remarks
Replaces and applies a set of HTTP Headers for the request.
- Defined in index.d.ts:150

setMethod

setMethod(method): HttpRequest
Parameters
- method: HttpRequestMethod
Returns HttpRequest
- Defined in index.d.ts:151

setTimeout

setTimeout(timeout): HttpRequest
Parameters
- timeout: number
Returns HttpRequest
- Defined in index.d.ts:152