Class HttpClientStream

Stream that sends a request and receives a response.

Create an HttpClientStream with request.

NOTE: The stream sends no data until activate is called. Call activate when you're ready for callbacks and events to fire.

Hierarchy

Constructors

constructor

Properties

connection request

Methods

activate close cork emit on status_code uncork

Events

DATA END ERROR HEADERS RESPONSE

Constructors

constructor

Properties

Readonly connection

connection: HttpConnection

Readonly request

request: HttpRequest

Methods

activate

  • Begin sending the request.

    The stream does nothing until this is called. Call activate() when you are ready for its callbacks and events to fire.

    Returns void

close

  • Closes and ends all communication on this stream. Called automatically after the 'end' event is delivered. Calling this manually is only necessary if you wish to terminate communication mid-request/response.

    Returns void

cork

  • Forces all written events to be buffered in memory. The buffered data will be flushed when uncork is called.

    Returns void

emit

  • Synchronously calls each of the listeners registered for the event key supplied in registration order. If the BufferedEventEmitter is currently corked, the event will be buffered until uncork is called.

    Parameters

    • event: EventKey

      The name of the event

    • Rest ...args: any[]

      Event payload

    Returns boolean

on

status_code

  • HTTP status code returned from the server.

    Returns undefined | Number

    Either the status code, or undefined if the server response has not arrived yet.

uncork

  • Flushes all data buffered since cork was called.

    NOTE: It is HIGHLY recommended that uncorking should always be done via process.nextTick, not during the EventEmitter.on() call.

    Returns void

Events

Static DATA

DATA: string = 'data'

Emitted when http response data is available.

Static END

END: string = 'end'

Emitted when the stream has completed

Static ERROR

ERROR: string = 'error'

Emitted when an error occurs in stream processing

Static HEADERS

HEADERS: string = 'headers'

Emitted when inline headers are delivered while communicating over H2

Static RESPONSE

RESPONSE: string = 'response'

Emitted when the http response headers have arrived.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc