Class RequestContext

Represents an HTTP request context

Hierarchy

RequestContext

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RequestContext(url: string, httpMethod: HttpMethod): RequestContext

- Defined in src/generated/http/http.ts:59
Creates the request context using a http method and request resource url

Parameters
- url: string
  
  url of the requested resource
- httpMethod: HttpMethod
  
  http method
Returns RequestContext

Properties

Private agent

agent: undefined | Agent | Agent = undefined

Private body

body: RequestBody = undefined

Private headers

headers: {} = {}

Type declaration

[key: string]: string

Private url

url: URL

Methods

addCookie

addCookie(name: string, value: string): void

- Defined in src/generated/http/http.ts:114
Sets a cookie with the name and value. NO check for duplicate cookies is performed

Parameters
- name: string
- value: string
Returns void

getAgent

getAgent(): undefined | Agent | Agent

- Defined in src/generated/http/http.ts:129
Returns undefined | Agent | Agent

getBody

getBody(): RequestBody

- Defined in src/generated/http/http.ts:102
Returns RequestBody

getHeaders

getHeaders(): {}

- Defined in src/generated/http/http.ts:98
Returns {}
- [key: string]: string

getHttpMethod

getHttpMethod(): HttpMethod

- Defined in src/generated/http/http.ts:94
Returns HttpMethod

getUrl

getUrl(): string

- Defined in src/generated/http/http.ts:67
Returns string

setAgent

setAgent(agent: Agent | Agent): void

- Defined in src/generated/http/http.ts:125
Parameters
- agent: Agent | Agent
Returns void

setBody

setBody(body: RequestBody): void

- Defined in src/generated/http/http.ts:90
Sets the body of the http request either as a string or FormData

Note that setting a body on a HTTP GET, HEAD, DELETE, CONNECT or TRACE request is discouraged. https://httpwg.org/http-core/draft-ietf-httpbis-semantics-latest.html#rfc.section.7.3.1

Parameters
- body: RequestBody
  
  the body of the request
Returns void

setHeaderParam

setHeaderParam(key: string, value: string): void

- Defined in src/generated/http/http.ts:121
Parameters
- key: string
- value: string
Returns void

setQueryParam

setQueryParam(name: string, value: string): void

- Defined in src/generated/http/http.ts:106
Parameters
- name: string
- value: string
Returns void

setUrl

setUrl(url: string): void

- Defined in src/generated/http/http.ts:77
Replaces the url set in the constructor with this url.

Parameters
- url: string
Returns void

Generated using TypeDoc