HttpClientResponse | @vertx/core

Represents a client-side HTTP response.

Vert.x provides you with one of these via the handler that was provided when creating the HttpClientRequest or that was set on the HttpClientRequest instance.

It implements ReadStream so it can be used with Pipe to pipe data with flow control.

Hierarchy

HttpClientResponse

Implements

ReadStream<Buffer>

Index

Methods

body

body(): PromiseLike<Buffer>
body(handler: ((res: AsyncResult<Buffer>) => void) | Handler<AsyncResult<Buffer>>): HttpClientResponse

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3809
Same as {@link HttpClientResponse#body} but with an handler called when the operation completes

Returns PromiseLike<Buffer>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3814
Same as {@link HttpClientResponse#body} but with an handler called when the operation completes

Parameters
- handler: ((res: AsyncResult<Buffer>) => void) | Handler<AsyncResult<Buffer>>
Returns HttpClientResponse

bodyHandler

bodyHandler(bodyHandler: ((res: Buffer) => void) | Handler<Buffer>): HttpClientResponse

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3804
Convenience method for receiving the entire request body in one piece.

This saves you having to manually set a dataHandler and an endHandler and append the chunks of the body until the whole body received. Don't use this if your request body is large - you could potentially run out of RAM.

Parameters
- bodyHandler: ((res: Buffer) => void) | Handler<Buffer>
Returns HttpClientResponse

cookies

cookies(): string

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3796
Returns string

customFrameHandler

customFrameHandler(handler: ((res: HttpFrame) => void) | Handler<HttpFrame>): HttpClientResponse

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3830
Set an custom frame handler. The handler will get notified when the http stream receives an custom HTTP/2 frame. HTTP/2 permits extension of the protocol.

Parameters
- handler: ((res: HttpFrame) => void) | Handler<HttpFrame>
Returns HttpClientResponse

end

end(): PromiseLike<void>
end(handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3819
Same as {@link HttpClientResponse#end} but with an handler called when the operation completes

Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3824
Same as {@link HttpClientResponse#end} but with an handler called when the operation completes

Parameters
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

endHandler

endHandler(endHandler: ((res: void) => void) | Handler<void> | null | undefined): HttpClientResponse

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3758
Parameters
- endHandler: ((res: void) => void) | Handler<void> | null | undefined
Returns HttpClientResponse

exceptionHandler

exceptionHandler(handler: ((res: Throwable) => void) | Handler<Throwable> | null | undefined): HttpClientResponse

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3752
Parameters
- handler: ((res: Throwable) => void) | Handler<Throwable> | null | undefined
Returns HttpClientResponse

fetch

fetch(amount: number): HttpClientResponse

Implementation of ReadStream.fetch
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3748
Parameters
- amount: number
Returns HttpClientResponse

getHeader

getHeader(headerName: string): string | null
getHeader(headerName: string): string

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3783
Return the first header value with the specified name

Parameters
- headerName: string
Returns string | null
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3846
Return the first header value with the specified name

Parameters
- headerName: string
Returns string

getTrailer

getTrailer(trailerName: string): string | null

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3788
Return the first trailer value with the specified name

Parameters
- trailerName: string
Returns string | null

handler

handler(handler: ((res: Buffer) => void) | Handler<Buffer> | null | undefined): HttpClientResponse

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3754
Parameters
- handler: ((res: Buffer) => void) | Handler<Buffer> | null | undefined
Returns HttpClientResponse

headers

headers(): MultiMap

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3778
Returns MultiMap

netSocket

netSocket(): NetSocket

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3762
Returns NetSocket

pause

pause(): HttpClientResponse

Implementation of ReadStream.pause
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3756
Returns HttpClientResponse

pipe

pipe(): Pipe<Buffer>

Implementation of ReadStream.pipe
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3726
Pause this stream and return a to transfer the elements of this stream to a destination .

The stream will be resumed when the pipe will be wired to a WriteStream.

Returns Pipe<Buffer>

pipeTo

pipeTo(dst: WriteStream<Buffer>): PromiseLike<void>
pipeTo(dst: WriteStream<Buffer>, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

Implementation of ReadStream.pipeTo
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3736
Pipe this ReadStream to the WriteStream.

Elements emitted by this stream will be written to the write stream until this stream ends or fails.
Once this stream has ended or failed, the write stream will be ended and the handler will be called with the result.

Parameters
- dst: WriteStream<Buffer>
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3746
Pipe this ReadStream to the WriteStream.

Elements emitted by this stream will be written to the write stream until this stream ends or fails.
Once this stream has ended or failed, the write stream will be ended and the handler will be called with the result.

Parameters
- dst: WriteStream<Buffer>
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns void

request

request(): HttpClientRequest

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3834
Returns HttpClientRequest

resume

resume(): HttpClientResponse

Implementation of ReadStream.resume
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3750
Returns HttpClientResponse

statusCode

statusCode(): number

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3770
Returns number

statusMessage

statusMessage(): string

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3774
Returns string

streamPriorityHandler

streamPriorityHandler(handler: ((res: StreamPriority) => void) | Handler<StreamPriority>): HttpClientResponse

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3841
Set an handler for stream priority changes.

This is not implemented for HTTP/1.x.

Parameters
- handler: ((res: StreamPriority) => void) | Handler<StreamPriority>
Returns HttpClientResponse

trailers

trailers(): MultiMap

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3792
Returns MultiMap

version

version(): HttpVersion

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3766
Returns HttpVersion

Hierarchy

Implements

Index

Methods

Methods

body

Returns PromiseLike<Buffer>

Parameters

handler: ((res: AsyncResult<Buffer>) => void) | Handler<AsyncResult<Buffer>>

Returns HttpClientResponse

bodyHandler

Parameters

bodyHandler: ((res: Buffer) => void) | Handler<Buffer>

Returns HttpClientResponse

cookies

Returns string

customFrameHandler

Parameters

handler: ((res: HttpFrame) => void) | Handler<HttpFrame>

Returns HttpClientResponse

end

Returns PromiseLike<void>

Parameters

handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns void

endHandler

Parameters

endHandler: ((res: void) => void) | Handler<void> | null | undefined

Returns HttpClientResponse

exceptionHandler

Parameters

handler: ((res: Throwable) => void) | Handler<Throwable> | null | undefined

Returns HttpClientResponse

fetch

Parameters

amount: number

Returns HttpClientResponse

getHeader

Parameters

headerName: string

Returns string | null

Parameters

headerName: string

Returns string

getTrailer

Parameters

trailerName: string

Returns string | null

handler

Parameters

handler: ((res: Buffer) => void) | Handler<Buffer> | null | undefined

Returns HttpClientResponse

headers

Returns MultiMap

netSocket

Returns NetSocket

pause

Returns HttpClientResponse

pipe

Returns Pipe<Buffer>

pipeTo

Parameters

dst: WriteStream<Buffer>

Returns PromiseLike<void>

Parameters

dst: WriteStream<Buffer>

handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns void

request

Returns HttpClientRequest

resume

Returns HttpClientResponse

statusCode

Returns number

statusMessage

Returns string

streamPriorityHandler

Parameters

handler: ((res: StreamPriority) => void) | Handler<StreamPriority>

Returns HttpClientResponse