Airstream/com.raquo.airstream.web

com.raquo.airstream.web

package com.raquo.airstream.web

Type members

Classlikes

class AjaxEventStream(method: String, url: String, data: InputData, timeoutMs: Int, headers: Map[String, String], withCredentials: Boolean, responseType: String, isStatusCodeSuccess: Int => Boolean, requestObserver: Observer[XMLHttpRequest], progressObserver: Observer[(XMLHttpRequest, ProgressEvent)], readyStateChangeObserver: Observer[XMLHttpRequest]) extends WritableEventStream[XMLHttpRequest]

AjaxEventStream performs an HTTP request and emits an dom.XMLHttpRequest on success, or an AjaxStreamError error (AjaxStatusError | AjaxNetworkError | AjaxTimeout | AjaxAbort) on failure.

AjaxEventStream performs an HTTP request and emits an dom.XMLHttpRequest on success, or an AjaxStreamError error (AjaxStatusError | AjaxNetworkError | AjaxTimeout | AjaxAbort) on failure.

Acceptable HTTP response status codes are 2xx and 304, others result in AjaxStatusError.

The network request is only performed when the stream is started.

When stream is restarted, a new request is performed, and the subsequent response is emitted. The previous request is not aborted, but its response will be ignored.

Warning: dom.XmlHttpRequest is an ugly, imperative JS construct. We set event callbacks for onload, onerror, onabort, ontimeout, and if requested, also for onprogress and onreadystatechange. Make sure you don't override Airstream's listeners, or this stream will not work properly.

Value Params
progressObserver
  • called when progress is reported
readyStateChangeObserver
  • called when readyState changes
requestObserver
  • called just before the request is sent
See also

dom.raw.XMLHttpRequest for a description of the parameters

Companion
object
object AjaxEventStream
Companion
class
object DomEventStream