fromevent.md

Rx.Observable.fromEvent(element, eventName, [selector])

Ⓢ

Creates an observable sequence by adding an event listener to the matching DOMElement, jQuery element, Zepto Element, Angular element, Ember.js element or EventEmitter.

Note that this uses the library approaches for jQuery, Zepto, Backbone.Marionette, AngularJS and Ember.js and falls back to native binding if not present. If you are using AMD you may need to include these libraries as dependencies of RxJs in your requirejs configuration file. RxJs will attempt to detect their presence when deciding which library to use.

Arguments

1. element (Any): The DOMElement, NodeList, jQuery element, Zepto Element, Angular element, Ember.js element or EventEmitter to attach a listener. For Backbone.Marionette this would be the application or an EventAggregator object.
2. eventName (String): The event name to attach the observable sequence.
3. [selector] (Function): A selector which takes the arguments from the event emitter so that you can return a single object.
4. [options] ( Object ) An object of event listener options.

Returns

(Observable): An observable sequence of events from the specified element and the specified event.

Example

Wrapping an event from jQuery

var input = $('#input');

var source = Rx.Observable.fromEvent(input, 'click');

var subscription = source.subscribe(
  function (x) {
    console.log('Next: Clicked!');
  },
  function (err) {
    console.log('Error: %s', err);
  },
  function () {
    console.log('Completed');
  });

input.trigger('click');

// => Next: Clicked!

Using in Node.js with using an EventEmitter with a selector function (which is not required).

var EventEmitter = require('events').EventEmitter,
    Rx = require('rx');

var eventEmitter = new EventEmitter();

var source = Rx.Observable.fromEvent(
  eventEmitter,
  'data',
  function (foo, bar) { return { foo: foo, bar: bar }; });

var subscription = source.subscribe(
  function (x) {
    console.log('Next: foo -' + x.foo + ', bar -' + x.bar);
  },
  function (err) {
    console.log('Error: ' + err);
  },
  function () {
    console.log('Completed');
  });

eventEmitter.emit('data', 'baz', 'quux');
// => Next: foo - baz, bar - quux

Location

File:

• /src/core/linq/observable/fromevent.js

Dist:

• rx.async.js
• rx.async.compat.js
• rx.lite.js
• rx.lite.compat.js

Prerequisites:

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

NPM Packages:

• rx

NuGet Packages:

• RxJS-Complete
• RxJS-Async
• RxJS-Lite

Unit Tests:

• /tests/observable/fromevent-compat.js
• /tests/observable/fromevent.js