Class ProxyRequest

Handles the interoperability of the request between the user agent and the origin.

Hierarchy

ProxyRequest

Index

Methods

Methods

absoluteURI

absoluteURI(): string

- Defined in io.vertx/vertx-http-proxy/target/npm/index.d.ts:170
Returns string

getAuthority

getAuthority(): string

- Defined in io.vertx/vertx-http-proxy/target/npm/index.d.ts:219
Returns string

getBody

getBody(): Body

- Defined in io.vertx/vertx-http-proxy/target/npm/index.d.ts:196
Returns Body

getMethod

getMethod(): HttpMethod

- Defined in io.vertx/vertx-http-proxy/target/npm/index.d.ts:174
Returns HttpMethod

getURI

getURI(): string

- Defined in io.vertx/vertx-http-proxy/target/npm/index.d.ts:185
Returns string

headers

headers(): MultiMap

- Defined in io.vertx/vertx-http-proxy/target/npm/index.d.ts:223
Returns MultiMap

proxiedRequest

proxiedRequest(): HttpServerRequest

- Defined in io.vertx/vertx-http-proxy/target/npm/index.d.ts:246
Returns HttpServerRequest

proxy

proxy(request: HttpClientRequest): PromiseLike<void>

- Defined in io.vertx/vertx-http-proxy/target/npm/index.d.ts:228
Proxy this request to the origin server using the specified request and then send the proxy response.

Parameters
- request: HttpClientRequest
Returns PromiseLike<void>

release

release(): ProxyRequest

- Defined in io.vertx/vertx-http-proxy/target/npm/index.d.ts:242
Release the proxy request and its associated resources

The HTTP server request is resumed, no HTTP server response is sent.

Returns ProxyRequest

response

response(): ProxyResponse

- Defined in io.vertx/vertx-http-proxy/target/npm/index.d.ts:251
Create and return the proxy response.

Returns ProxyResponse

send

send(request: HttpClientRequest): PromiseLike<ProxyResponse>

- Defined in io.vertx/vertx-http-proxy/target/npm/index.d.ts:235
Send this request to the origin server using the specified request.

The returned future will be completed with the proxy response returned by the origin.

Parameters
- request: HttpClientRequest
Returns PromiseLike<ProxyResponse>

setAuthority

setAuthority(authority: string): ProxyRequest

- Defined in io.vertx/vertx-http-proxy/target/npm/index.d.ts:215
Set the request authority
- for HTTP/1 the header
- for HTTP/2 the pseudo header
The value must follow the syntax.
Parameters
- authority: string
Returns ProxyRequest

setBody

setBody(body: Body): ProxyRequest

- Defined in io.vertx/vertx-http-proxy/target/npm/index.d.ts:203
Set the request body to be sent to the origin server.

The initial request body value is the proxied request body.

Parameters
- body: Body
Returns ProxyRequest

setMethod

setMethod(method: HttpMethod): ProxyRequest

- Defined in io.vertx/vertx-http-proxy/target/npm/index.d.ts:181
Set the HTTP method to be sent to the origin server.

The initial HTTP method value is the proxied request HTTP method.

Parameters
- method: HttpMethod
Returns ProxyRequest

setURI

setURI(uri: string): ProxyRequest

- Defined in io.vertx/vertx-http-proxy/target/npm/index.d.ts:192
Set the request URI to be sent to the origin server.

The initial request URI value is the proxied request URI.

Parameters
- uri: string
Returns ProxyRequest

version

version(): HttpVersion

- Defined in io.vertx/vertx-http-proxy/target/npm/index.d.ts:166
Returns HttpVersion

Static reverseProxy

reverseProxy(proxiedRequest: HttpServerRequest): ProxyRequest

- Defined in io.vertx/vertx-http-proxy/target/npm/index.d.ts:162
Create a new ProxyRequest instance, the proxied request will be paused.

Parameters
- proxiedRequest: HttpServerRequest
Returns ProxyRequest

Generated using TypeDoc