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[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

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

   Writable

   Example:

   1. writable.cork()

9.  val domain: String

   Definition Classes

   IEventEmitter

10.  def emit(name: String, args: Any*): Any

    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][, ...])

11.  def end(): Unit

    Call this method when no more data will be written to the stream.

    Call this method when no more data will be written to the stream. If supplied, the callback is attached as a listener on the 'finish' event. Calling stream.write() after calling stream.end() will raise an error.

    Definition Classes

    Writable

    Example:

    1. writable.end([chunk][, encoding][, callback])

12.  def end(callback: Function): Unit

    Call this method when no more data will be written to the stream.

    Call this method when no more data will be written to the stream. If supplied, the callback is attached as a listener on the 'finish' event. Calling stream.write() after calling stream.end() will raise an error.

    callback

    the Callback for when this chunk of data is flushed

    Definition Classes

    Writable

    Example:

    1. writable.end([chunk][, encoding][, callback])

13.  def end(chunk: |[String, Buffer], callback: Function): Unit

    Call this method when no more data will be written to the stream.

    Call this method when no more data will be written to the stream. If supplied, the callback is attached as a listener on the 'finish' event. Calling stream.write() after calling stream.end() will raise an error.

    chunk

    The data to write (<String> | <Buffer>)

    callback

    the Callback for when this chunk of data is flushed

    Definition Classes

    Writable

    Example:

    1. writable.end([chunk][, encoding][, callback])

14.  def end(chunk: |[String, Buffer], encoding: String = js.native): Unit

    Call this method when no more data will be written to the stream.

    Call this method when no more data will be written to the stream. If supplied, the callback is attached as a listener on the 'finish' event. Calling stream.write() after calling stream.end() will raise an error.

    chunk

    The data to write (<String> | <Buffer>)

    encoding

    The encoding, if chunk is a String

    Definition Classes

    Writable

    Example:

    1. writable.end([chunk][, encoding][, callback])

15.  def end(chunk: |[String, Buffer], encoding: String, callback: Function): Unit

    Call this method when no more data will be written to the stream.

    Call this method when no more data will be written to the stream. If supplied, the callback is attached as a listener on the 'finish' event. Calling stream.write() after calling stream.end() will raise an error.

    chunk

    The data to write (<String> | <Buffer>)

    encoding

    The encoding, if chunk is a String

    callback

    the Callback for when this chunk of data is flushed

    Definition Classes

    Writable

    Example:

    1. writable.end([chunk][, encoding][, callback])

16.  final def eq(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

17.  def equals(arg0: Any): Boolean

    Definition Classes

    AnyRef → Any

18.  def finalize(): Unit

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

19.  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.

20.  final def getClass(): Class[_]

    Definition Classes

    AnyRef → Any

21.  def getHeader(name: String): UndefOr[String]

    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.

22.  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()

23.  def hasOwnProperty(v: String): Boolean

    Definition Classes

    Object

24.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

25.  def headers: Dictionary[String]

    The response headers

26.  def headersSent: Boolean

    Boolean (read-only).

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

27.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

28.  def isPrototypeOf(v: Object): Boolean

    Definition Classes

    Object

29.  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)

30.  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)

31.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

32.  final def notify(): Unit

    Definition Classes

    AnyRef

33.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

34.  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)

35.  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)

36.  def propertyIsEnumerable(v: String): Boolean

    Definition Classes

    Object

37.  def removeAllListeners(): 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])

38.  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

    Example:

    1. emitter.removeAllListeners([eventName])

39.  def removeHeader(name: String): Unit

    Removes a header that's queued for implicit sending.

40.  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)

41.  def render(path: String): Unit
42.  def send(data: Any): Unit
43.  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.

44.  def sendStatus(statusCode: Int): Unit
45.  def set(headers: Any): Unit
46.  def set(name: String, value: Any): Unit
47.  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

    Writable

    Example:

    1. writable.setDefaultEncoding(encoding)

48.  def setEncoding(encoding: String): Unit
49.  def setHeader(name: String, value: String): 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.

50.  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)

51.  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.

52.  def status(statusCode: Int): ServerResponse.this.type
53.  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.

54.  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.

55.  final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes

    AnyRef

56.  def toLocaleString(): String

    Definition Classes

    Object

57.  def toString(): String

    Definition Classes

    AnyRef → Any

58.  def type(mime: String): UndefOr[String]
59.  def uncork(): Unit

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

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

    Definition Classes

    Writable

    Example:

    1. writable.uncork()

60.  val usingDomains: Boolean

    Definition Classes

    IEventEmitter

61.  def valueOf(): Any

    Definition Classes

    Object

62.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

63.  final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

64.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

65.  def write(chunk: |[String, Buffer], encoding: String = null): Boolean

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

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

    chunk

    The data to write (<String> | <Buffer>)

    encoding

    The encoding, if chunk is a String

    returns

    true, if the data was handled completely

    Definition Classes

    Writable

    Example:

    1. writable.write(chunk[, encoding][, callback])

66.  def write(chunk: |[String, Buffer], encoding: String, callback: Function): Boolean

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

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

    chunk

    The data to write (<String> | <Buffer>)

    encoding

    The encoding, if chunk is a String

    callback

    the Callback for when this chunk of data is flushed

    returns

    true, if the data was handled completely

    Definition Classes

    Writable

    Example:

    1. writable.write(chunk[, encoding][, callback])

67.  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.

68.  def writeHead(statusCode: Int, headers: Any = null): Unit
69.  def writeHead(statusCode: Int, statusMessage: String): Unit
70.  def writeHead(statusCode: Int, statusMessage: String, headers: Any): Unit

    Sends a response header to the request.

    Sends a response header to the request. The status code is a 3-digit HTTP status code, like 404. The last argument, headers, are the response headers. Optionally one can give a human-readable statusMessage as the second argument.

    Example:

    1. response.writeHead(statusCode[, statusMessage][, headers])