trait ServerResponse extends Writable
Node.js http.ServerResponse
- Annotations
- @JSType() @native()
- See also
https://nodejs.org/api/http.html#http_class_http_serverresponse
- Alphabetic
- By Inheritance
- ServerResponse
- Writable
- IWritable
- LegacyStream
- IEventEmitter
- Stream
- Object
- Any
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def addListener(eventName: String, listener: Function): ServerResponse.this.type
Alias for emitter.on(eventName, listener).
Alias for emitter.on(eventName, listener).
- Definition Classes
- IEventEmitter
emitter.addListener(eventName, listener)
- See also
on()
Example: - 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.
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- 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
writable.cork()
Example: - def destroy(): Unit
- Definition Classes
- IWritable
- def destroy(error: Error): Unit
- Definition Classes
- IWritable
- def destroyed: Boolean
- Definition Classes
- IWritable
- val domain: Domain
- Definition Classes
- IEventEmitter
- 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
emitter.emit(name[, arg1][, arg2][, ...])
Example: - def end(): ServerResponse.this.type
- Definition Classes
- IWritable
- def end(callback: Function1[Error, Any]): ServerResponse.this.type
- Definition Classes
- IWritable
- def end(chunk: String, encoding: String): ServerResponse.this.type
- Definition Classes
- IWritable
- def end(chunk: String, encoding: String, callback: Function1[Error, Any]): ServerResponse.this.type
- Definition Classes
- IWritable
- def end(chunk: Uint8Array): ServerResponse.this.type
- Definition Classes
- IWritable
- def end(chunk: String): ServerResponse.this.type
- Definition Classes
- IWritable
- def end(chunk: Uint8Array, callback: Function1[Error, Any]): ServerResponse.this.type
- Definition Classes
- IWritable
- def end(chunk: String, callback: Function1[Error, Any]): ServerResponse.this.type
- Definition Classes
- IWritable
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def eventNames(): Array[String]
- Definition Classes
- IEventEmitter
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def flushHeaders(): Unit
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- 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.
- def getHeaderNames(): Array[String]
- def getHeaders(): Dictionary[Any]
- 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
emitter.getMaxListeners()
- See also
setMaxListeners()
Example: - def hasHeader(name: String): Boolean
- def hasOwnProperty(v: String): Boolean
- Definition Classes
- Object
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def headers: Dictionary[String]
The response headers
- def headersSent: Boolean
Boolean (read-only).
Boolean (read-only). True if headers were sent, false otherwise.
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isPrototypeOf(v: Object): Boolean
- Definition Classes
- Object
- 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
emitter.listenerCount(eventName)
Example: - 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
emitter.listeners(eventName)
Example: - final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def off(eventName: String, listner: Function): ServerResponse.this.type
- Definition Classes
- IEventEmitter
- 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
emitter.on(eventName, listener)
Example: - 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
emitter.once(eventName, listener)
Example: - def prependListener(eventName: String, listener: Function): ServerResponse.this.type
- Definition Classes
- IEventEmitter
- def prependOnceListener(eventName: String, listener: Function): ServerResponse.this.type
- Definition Classes
- IEventEmitter
- def propertyIsEnumerable(v: String): Boolean
- Definition Classes
- Object
- def rawListeners(eventName: String): Array[Function]
- Definition Classes
- IEventEmitter
- def removeAllListeners(): ServerResponse.this.type
- Definition Classes
- IEventEmitter
- def removeAllListeners(eventName: String): 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
emitter.removeAllListeners([eventName])
Example: - def removeHeader(name: String): Unit
Removes a header that's queued for implicit sending.
- 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
emitter.removeListener(eventName, listener)
Example: - def render(path: String): Unit
- def send(data: Any): Unit
- 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.
- def sendStatus(statusCode: Int): Unit
- def set(headers: Any): Unit
- def set(name: String, value: Any): Unit
- 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
writable.setDefaultEncoding(encoding)
Example: - 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.
- 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
emitter.setMaxListeners(n)
Example: - def setTimeout(msecs: Int): Unit
- def setTimeout(msecs: Int, callback: Function): 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.
- def socket: Socket
- def status(statusCode: Int): ServerResponse.this.type
- 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.
- 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.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toLocaleString(): String
- Definition Classes
- Object
- def toString(): String
- Definition Classes
- AnyRef → Any
- def type(mime: String): UndefOr[String]
- def uncork(): Unit
Flush all data, buffered since stream.cork() call.
Flush all data, buffered since stream.cork() call.
- Definition Classes
- IWritable
writable.uncork()
Example: - def valueOf(): Any
- Definition Classes
- Object
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def writable: Boolean
- Definition Classes
- IWritable
- def writableCorked: Int
- Definition Classes
- IWritable
- def writableEnded: Boolean
- Definition Classes
- IWritable
- def writableFinished: Boolean
- Definition Classes
- IWritable
- def writableHighWaterMark: Double
- Definition Classes
- IWritable
- def writableLength: Int
- Definition Classes
- IWritable
- def writableObjectMode: Boolean
- Definition Classes
- IWritable
- def write(chunk: String, encoding: String, callback: Function1[Error, Any]): Boolean
- Definition Classes
- IWritable
- def write(chunk: String, encoding: String): Boolean
- Definition Classes
- IWritable
- def write(chunk: String): Boolean
- Definition Classes
- IWritable
- def write(chunk: String, callback: Function1[Error, Any]): Boolean
- Definition Classes
- IWritable
- def write(chunk: Uint8Array): Boolean
- Definition Classes
- IWritable
- def write(chunk: Uint8Array, callback: Function1[Error, Any]): Boolean
- Definition Classes
- IWritable
- 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.
- def writeHead(statusCode: Int): Unit
- def writeHead(statusCode: Int, headers: Dictionary[_]): Unit
- def writeHead(statusCode: Int, headers: Object): Unit
- def writeHead(statusCode: Int, statusMessage: String): Unit
- def writeHead(statusCode: Int, statusMessage: String, headers: Dictionary[_]): Unit
- def writeHead(statusCode: Int, statusMessage: String, headers: Object): Unit
- def writeProcessing(): Unit
Deprecated Value Members
- 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.
- Annotations
- @deprecated
- Deprecated
(Since version Node.js v13.0.0) Use response.writableEnd