Packages

trait ServerResponse extends Writable

Node.js http.ServerResponse

Annotations
@RawJSType() @native()
See also

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

Linear Supertypes
Writable, IWritable, LegacyStream, IEventEmitter, Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ServerResponse
  2. Writable
  3. IWritable
  4. LegacyStream
  5. IEventEmitter
  6. Object
  7. Any
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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 addListener(eventName: String, listener: Function): ServerResponse.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()

  5. def addTrailers(headers: Any): Unit

    This method adds HTTP trailing headers (a header but at the end of the message) to the response.

    This method adds HTTP trailing headers (a header but at the end of the message) to the response. Trailers will only be emitted if chunked encoding is used for the response; if it is not (e.g., if the request was HTTP/1.0), they will be silently discarded.

    Note that HTTP requires the Trailer header to be sent if you intend to emit trailers, with a list of the header fields in its value.

  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  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(error: Error = js.native): Unit
    Definition Classes
    IWritable
  10. def destroyed: Boolean
    Definition Classes
    IWritable
  11. val domain: String
    Definition Classes
    IEventEmitter
  12. 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][, ...])

  13. def end(callback: Function1[Error, Any] = js.native): UndefOr[ServerResponse.this.type]
    Definition Classes
    IWritable
  14. def end(chunk: String, encoding: String): UndefOr[ServerResponse.this.type]
    Definition Classes
    IWritable
  15. def end(chunk: String, encoding: String, callback: Function1[Error, Any]): UndefOr[ServerResponse.this.type]
    Definition Classes
    IWritable
  16. def end(chunk: |[String, Uint8Array]): UndefOr[ServerResponse.this.type]
    Definition Classes
    IWritable
  17. def end(chunk: |[String, Uint8Array], callback: Function1[Error, Any]): UndefOr[ServerResponse.this.type]
    Definition Classes
    IWritable
  18. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  20. def eventNames(): Array[String]
    Definition Classes
    IEventEmitter
  21. def finished: Boolean

    Boolean value that indicates whether the response has completed.

    Boolean value that indicates whether the response has completed. Starts as false. After response.end() executes, the value will be true.

  22. def flushHeaders(): Unit
  23. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. def getHeader[T <: Any](name: String): UndefOr[T]

    Reads out a header that's already been queued but not sent to the client.

    Reads out a header that's already been queued but not sent to the client. Note that the name is case insensitive. This can only be called before headers get implicitly flushed.

  25. def getHeaderNames(): Array[String]
  26. def getHeaders(): Dictionary[Any]
  27. 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()

  28. def hasHeader(name: String): Boolean
  29. def hasOwnProperty(v: String): Boolean
    Definition Classes
    Object
  30. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  31. def headers: Dictionary[String]

    The response headers

  32. def headersSent: Boolean

    Boolean (read-only).

    Boolean (read-only). True if headers were sent, false otherwise.

  33. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  34. def isPrototypeOf(v: Object): Boolean
    Definition Classes
    Object
  35. 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)

  36. 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)

  37. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  38. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  39. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  40. def on(eventName: String, listener: Function): ServerResponse.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)

  41. def once(eventName: String, listener: Function): ServerResponse.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)

  42. def prependListener(eventName: String, listener: Function): ServerResponse.this.type
    Definition Classes
    IEventEmitter
  43. def prependOnceListener(eventName: String, listener: Function): ServerResponse.this.type
    Definition Classes
    IEventEmitter
  44. def propertyIsEnumerable(v: String): Boolean
    Definition Classes
    Object
  45. def removeAllListeners(eventName: String = js.native): ServerResponse.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])

  46. def removeHeader(name: String): Unit

    Removes a header that's queued for implicit sending.

  47. def removeListener(eventName: String, listener: Function): ServerResponse.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)

  48. def render(path: String): Unit
  49. def send(data: Any): Unit
  50. val sendDate: Boolean

    When true, the Date header will be automatically generated and sent in the response if it is not already present in the headers.

    When true, the Date header will be automatically generated and sent in the response if it is not already present in the headers. Defaults to true.

  51. def sendStatus(statusCode: Int): Unit
  52. def set(headers: Any): Unit
  53. def set(name: String, value: Any): Unit
  54. def setDefaultEncoding(encoding: String): ServerResponse.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)

  55. def setHeader(name: String, value: Any): Unit

    Sets a single header value for implicit headers.

    Sets a single header value for implicit headers. If this header already exists in the to-be-sent headers, its value will be replaced. Use an array of strings here if you need to send multiple headers with the same name.

  56. def setMaxListeners(n: Int): ServerResponse.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)

  57. def setTimeout(msecs: Int, callback: Function = js.native): Unit

    Sets the Socket's timeout value to msecs.

    Sets the Socket's timeout value to msecs. If a callback is provided, then it is added as a listener on the 'timeout' event on the response object.

    If no 'timeout' listener is added to the request, the response, or the server, then sockets are destroyed when they time out. If you assign a handler on the request, the response, or the server's 'timeout' events, then it is your responsibility to handle timed out sockets.

    Returns response.

  58. def socket: Socket
  59. def status(statusCode: Int): ServerResponse.this.type
  60. val statusCode: Int

    When using implicit headers (not calling response.writeHead() explicitly), this property controls the status code that will be sent to the client when the headers get flushed.

  61. val statusMessage: UndefOr[String]

    When using implicit headers (not calling response.writeHead() explicitly), this property controls the status message that will be sent to the client when the headers get flushed.

    When using implicit headers (not calling response.writeHead() explicitly), this property controls the status message that will be sent to the client when the headers get flushed. If this is left as undefined then the standard message for the status code will be used.

  62. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  63. def toLocaleString(): String
    Definition Classes
    Object
  64. def toString(): String
    Definition Classes
    AnyRef → Any
  65. def type(mime: String): UndefOr[String]
  66. 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()

  67. val usingDomains: Boolean
    Definition Classes
    IEventEmitter
  68. def valueOf(): Any
    Definition Classes
    Object
  69. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  70. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  71. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  72. def write(chunk: String, encoding: String, callback: Function1[Error, Any]): Boolean
    Definition Classes
    IWritable
  73. def write(chunk: String, encoding: String): Boolean
    Definition Classes
    IWritable
  74. def write(chunk: |[Uint8Array, String], callback: Function1[Error, Any] = js.native): Boolean
    Definition Classes
    IWritable
  75. def writeContinue(): Unit

    Sends a HTTP/1.1 100 Continue message to the client, indicating that the request body should be sent.

    Sends a HTTP/1.1 100 Continue message to the client, indicating that the request body should be sent. See the 'checkContinue' event on Server.

  76. def writeHead(statusCode: Int): Unit
  77. def writeHead(statusCode: Int, headers: |[Object, Dictionary[_]]): Unit
  78. def writeHead(statusCode: Int, statusMessage: String, headers: |[Object, Dictionary[_]] = js.native): Unit

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Writable

Inherited from IWritable

Inherited from LegacyStream

Inherited from IEventEmitter

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped