Class HttpRequest`Beta`

Main object for structuring a request.

Index

Constructors

Properties

body headers method timeout uri

Methods

addHeader setBody setHeaders setMethod setTimeout

Constructors

constructor

new HttpRequest(uri: string): HttpRequest
Beta
Parameters
- uri: string
Returns HttpRequest

Properties

`Beta`body

body: string

Content of the body of the HTTP request.

`Beta`headers

headers: HttpHeader[]

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

`Beta`method

method: HttpRequestMethod

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

`Beta`timeout

timeout: number

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

`Beta`uri

uri: string

The HTTP resource to access.

Methods

addHeader

addHeader(key: string, value: string | SecretString): HttpRequest
Beta
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.

setBody

setBody(body: string): HttpRequest
Beta
Parameters
- body: string
Returns HttpRequest
Remarks
Updates the content of the body of the HTTP request.

setHeaders

setHeaders(headers: HttpHeader[]): HttpRequest
Beta
Parameters
- headers: HttpHeader[]
Returns HttpRequest
Remarks
Replaces and applies a set of HTTP Headers for the request.

setMethod

setMethod(method: HttpRequestMethod): HttpRequest
Beta
Parameters
- method: HttpRequestMethod
Returns HttpRequest
Remarks
Sets the desired HTTP method (e.g., GET or PUT or PATCH) to use for making the request.

setTimeout

setTimeout(timeout: number): HttpRequest
Beta
Parameters
- timeout: number
Returns HttpRequest