Packages

c

io.scalajs.nodejs.http

ClientRequest

class ClientRequest extends Writable

http.ClientRequest - This object is created internally and returned from http.request(). It represents an in-progress request whose header has already been queued. The header is still mutable using the setHeader(name, value), getHeader(name), removeHeader(name) API. The actual header will be sent along with the first data chunk or when closing the connection.

To get the response, add a listener for 'response' to the request object. 'response' will be emitted from the request object when the response headers have been received. The 'response' event is executed with one argument which is an instance of http.IncomingMessage.

During the 'response' event, one can add listeners to the response object; particularly to listen for the 'data' event. If no 'response' handler is added, then the response will be entirely discarded. However, if you add a 'response' event handler, then you must consume the data from the response object, either by calling response.read() whenever there is a 'readable' event, or by adding a 'data' handler, or by calling the .resume() method. Until the data is consumed, the 'end' event will not fire. Also, until the data is read it will consume memory that can eventually lead to a 'process out of memory' error.

Note: Node.js does not check whether Content-Length and the length of the body which has been transmitted are equal or not.

Annotations
@JSType() @native() @JSImport("http", "ClientRequest")
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ClientRequest
  2. Writable
  3. IWritable
  4. LegacyStream
  5. IEventEmitter
  6. Stream
  7. Object
  8. Any
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ClientRequest()

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def aborted: |[Int, Boolean]
  5. def addListener(eventName: String, listener: Function): ClientRequest.this.type

    Alias for emitter.on(eventName, listener).

    Alias for emitter.on(eventName, listener).

    Definition Classes
    IEventEmitter
    Example:
    1. emitter.addListener(eventName, listener)

    See also

    on()

  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def cork(): Unit

    Forces buffering of all writes.

    Forces buffering of all writes. Buffered data will be flushed either at stream.uncork() or at stream.end() call.

    Definition Classes
    IWritable
    Example:
    1. writable.cork()

  9. def destroy(): Unit
    Definition Classes
    IWritable
  10. def destroy(error: Error): Unit
    Definition Classes
    IWritable
  11. def destroyed: Boolean
    Definition Classes
    IWritable
  12. val domain: Domain
    Definition Classes
    IEventEmitter
  13. def emit(name: String, args: Any*): Boolean

    Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

    Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

    Returns true if the event had listeners, false otherwise.

    name

    the event name

    args

    the event arguments

    Definition Classes
    IEventEmitter
    Example:
    1. emitter.emit(name[, arg1][, arg2][, ...])

  14. def end(): ClientRequest.this.type
    Definition Classes
    IWritable
  15. def end(callback: Function1[Error, Any]): ClientRequest.this.type
    Definition Classes
    IWritable
  16. def end(chunk: String, encoding: String): ClientRequest.this.type
    Definition Classes
    IWritable
  17. def end(chunk: String, encoding: String, callback: Function1[Error, Any]): ClientRequest.this.type
    Definition Classes
    IWritable
  18. def end(chunk: Uint8Array): ClientRequest.this.type
    Definition Classes
    IWritable
  19. def end(chunk: String): ClientRequest.this.type
    Definition Classes
    IWritable
  20. def end(chunk: Uint8Array, callback: Function1[Error, Any]): ClientRequest.this.type
    Definition Classes
    IWritable
  21. def end(chunk: String, callback: Function1[Error, Any]): ClientRequest.this.type
    Definition Classes
    IWritable
  22. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  24. def eventNames(): Array[String]
    Definition Classes
    IEventEmitter
  25. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  26. def flushHeaders(): Unit

    Flush the request headers.

    Flush the request headers.

    For efficiency reasons, Node.js normally buffers the request headers until you call request.end() or write the first chunk of request data. It then tries hard to pack the request headers and data into a single TCP packet.

    That's usually what you want (it saves a TCP round-trip) but not when the first data isn't sent until possibly much later. request.flushHeaders() lets you bypass the optimization and kickstart the request.

    See also

    https://nodejs.org/api/http.html#http_request_flushheaders

  27. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  28. def getHeader[T <: Any](name: String): T
  29. def getMaxListeners(): Int

    Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.

    Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.

    Definition Classes
    IEventEmitter
    Example:
    1. emitter.getMaxListeners()

    See also

    setMaxListeners()

  30. def hasOwnProperty(v: String): Boolean
    Definition Classes
    Object
  31. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  32. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  33. def isPrototypeOf(v: Object): Boolean
    Definition Classes
    Object
  34. def listenerCount(eventName: String): Int

    Returns the number of listeners listening to the event named eventName.

    Returns the number of listeners listening to the event named eventName.

    Definition Classes
    IEventEmitter
    Example:
    1. emitter.listenerCount(eventName)

  35. def listeners(eventName: String): Array[Function]

    Returns a copy of the array of listeners for the event named eventName.

    Returns a copy of the array of listeners for the event named eventName.

    Definition Classes
    IEventEmitter
    Example:
    1. emitter.listeners(eventName)

  36. var maxHeadersCount: |[Int, Null]
  37. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  38. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  39. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  40. def off(eventName: String, listner: Function): ClientRequest.this.type
    Definition Classes
    IEventEmitter
  41. def on(eventName: String, listener: Function): ClientRequest.this.type

    Adds the listener function to the end of the listeners array for the event named eventName.

    Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

    Returns a reference to the EventEmitter so calls can be chained.

    Definition Classes
    IEventEmitter
    Example:
    1. emitter.on(eventName, listener)

  42. def once(eventName: String, listener: Function): ClientRequest.this.type

    Adds a one time listener function for the event named eventName.

    Adds a one time listener function for the event named eventName. This listener is invoked only the next time eventName is triggered, after which it is removed.

    Definition Classes
    IEventEmitter
    Example:
    1. emitter.once(eventName, listener)

  43. def path: String
  44. def prependListener(eventName: String, listener: Function): ClientRequest.this.type
    Definition Classes
    IEventEmitter
  45. def prependOnceListener(eventName: String, listener: Function): ClientRequest.this.type
    Definition Classes
    IEventEmitter
  46. def propertyIsEnumerable(v: String): Boolean
    Definition Classes
    Object
  47. def rawListeners(eventName: String): Array[Function]
    Definition Classes
    IEventEmitter
  48. def removeAllListeners(): ClientRequest.this.type
    Definition Classes
    IEventEmitter
  49. def removeAllListeners(eventName: String): ClientRequest.this.type

    Removes all listeners, or those of the specified eventName.

    Removes all listeners, or those of the specified eventName.

    Note that it is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

    Returns a reference to the EventEmitter so calls can be chained.

    Definition Classes
    IEventEmitter
    Example:
    1. emitter.removeAllListeners([eventName])

  50. def removeHeader(name: String): Unit
  51. def removeListener(eventName: String, listener: Function): ClientRequest.this.type

    Removes the specified listener from the listener array for the event named eventName.

    Removes the specified listener from the listener array for the event named eventName. removeListener will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener must be called multiple times to remove each instance.

    Note that once an event has been emitted, all listeners attached to it at the time of emitting will be called in order. This implies that any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution will not remove them from emit() in progress. Subsequent events will behave as expected.

    Definition Classes
    IEventEmitter
    Example:
    1. emitter.removeListener(eventName, listener)

  52. def reusedSocket: Boolean
  53. def setDefaultEncoding(encoding: String): ClientRequest.this.type

    Sets the default encoding for a writable stream.

    Sets the default encoding for a writable stream.

    Definition Classes
    IWritable
    Example:
    1. writable.setDefaultEncoding(encoding)

  54. def setHeader(name: String, value: Any): Unit
  55. def setMaxListeners(n: Int): ClientRequest.this.type

    By default EventEmitters will print a warning if more than 10 listeners are added for a particular event.

    By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. Obviously, not all events should be limited to just 10 listeners. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) for to indicate an unlimited number of listeners.

    Returns a reference to the EventEmitter so calls can be chained.

    Definition Classes
    IEventEmitter
    Example:
    1. emitter.setMaxListeners(n)

  56. def setNoDelay(): Unit
  57. def setNoDelay(noDelay: Boolean): Unit

    Once a socket is assigned to this request and is connected socket.setNoDelay() will be called.

  58. def setNoDelay(noDelay: Int): Unit

    Once a socket is assigned to this request and is connected socket.setNoDelay() will be called.

  59. def setSocketKeepAlive(): Unit
  60. def setSocketKeepAlive(initialDelay: Int): Unit
  61. def setSocketKeepAlive(enable: Boolean): Unit
  62. def setSocketKeepAlive(enable: Boolean, initialDelay: Int): Unit

    Once a socket is assigned to this request and is connected socket.setKeepAlive() will be called.

    Once a socket is assigned to this request and is connected socket.setKeepAlive() will be called.

    See also

    https://nodejs.org/api/http.html#http_request_setsocketkeepalive_enable_initialdelay

  63. def setTimeout(timeout: Int): Unit
  64. def setTimeout(timeout: Int, callback: Function): Unit

    Once a socket is assigned to this request and is connected socket.setTimeout() will be called.

    Once a socket is assigned to this request and is connected socket.setTimeout() will be called.

    • timeout {Number} Milliseconds before a request is considered to be timed out.
    • callback {Function} Optional function to be called when a timeout occurs. Same as binding to the timeout event.
  65. def socket: Socket
  66. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  67. def toLocaleString(): String
    Definition Classes
    Object
  68. def toString(): String
    Definition Classes
    AnyRef → Any
  69. def uncork(): Unit

    Flush all data, buffered since stream.cork() call.

    Flush all data, buffered since stream.cork() call.

    Definition Classes
    IWritable
    Example:
    1. writable.uncork()

  70. def valueOf(): Any
    Definition Classes
    Object
  71. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  72. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  73. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  74. def writable: Boolean
    Definition Classes
    IWritable
  75. def writableCorked: Int
    Definition Classes
    IWritable
  76. def writableEnded: Boolean
    Definition Classes
    IWritable
  77. def writableFinished: Boolean
    Definition Classes
    IWritable
  78. def writableHighWaterMark: Double
    Definition Classes
    IWritable
  79. def writableLength: Int
    Definition Classes
    IWritable
  80. def writableObjectMode: Boolean
    Definition Classes
    IWritable
  81. def write(chunk: String, encoding: String, callback: Function1[Error, Any]): Boolean
    Definition Classes
    IWritable
  82. def write(chunk: String, encoding: String): Boolean
    Definition Classes
    IWritable
  83. def write(chunk: String): Boolean
    Definition Classes
    IWritable
  84. def write(chunk: String, callback: Function1[Error, Any]): Boolean
    Definition Classes
    IWritable
  85. def write(chunk: Uint8Array): Boolean
    Definition Classes
    IWritable
  86. def write(chunk: Uint8Array, callback: Function1[Error, Any]): Boolean
    Definition Classes
    IWritable

Deprecated Value Members

  1. def abort(): Unit

    Marks the request as aborting.

    Marks the request as aborting. Calling this will cause remaining data in the response to be dropped and the socket to be destroyed.

    Annotations
    @deprecated
    Deprecated

    (Since version Node.js v14.1.0) Use destroy()

    See also

    https://nodejs.org/api/http.html#http_request_abort

  2. def connection: Socket
    Annotations
    @deprecated
    Deprecated

    (Since version Node.js v13.0.0) Use request.socket

  3. def finished: Boolean
    Annotations
    @deprecated
    Deprecated

    (Since version Node.js v13.4.0, v12.16.0) Use request.writableEnded

Inherited from Writable

Inherited from IWritable

Inherited from LegacyStream

Inherited from IEventEmitter

Inherited from Stream

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped