get.md

Rx.DOM.ajax.get(url)`

Rx.DOM.ajax.get(settings)`

Ⓢ

Creates an observable sequence from an Ajax GET Request with the body. This is just a shortcut to the Rx.DOM.ajax method with the GET method.

Arguments

• url (String): A string of the URL to make the Ajax call.

OR

• settings (Object): An object with the following properties:

  • async (Boolean): Whether the request is async. The default is true.
  • body (Object): Optional body
  • crossDomain (Boolean): true if to use CORS, else false. The default is false.
  • headers (Object): Optional headers
  • password (String): The password for the request.
  • progressObserver (Observer): An optional Observer which listen to XHR2 progress events.
  • responseType (String): The response type. Either can be 'json' or 'text'. The default is 'text'
  • url (String): URL of the request
  • user (String): The user for the request.

Returns

(Observable): The observable sequence which contains the response from the Ajax GET.

Example

Rx.DOM.get('/products')
  .subscribe(
    function (data) {
      var text = data.response;
      console.log(text);
    },
    function (err) {
      // Log the error
    }
  );

Location

File:

• /src/ajax.js

Dist:

• rx.dom.js | - rx.dom.compat.js

Prerequisites:

• If using rx.js
  • rx.js | rx.compat.js
  • rx.binding.js
• rx.lite.js | rx.lite.compat.js

NPM Packages:

• rx-dom

NuGet Packages:

• RxJS-Bridges-HTML

Unit Tests:

• `/tests/ajax/tests.ajax.js