keypress.md

Rx.DOM.keypress(element, [selector], [useCapture])

Ⓢ

Creates an observable sequence by adding an event listener to the matching DOMElement or DOMNodeList for the keypress event.

Arguments

1. element (Any): The DOMElement, DOMNodeList to attach a listener.
2. [selector] (Function): A selector which takes the arguments from the event handler to produce a single item to yield on next.
3. [useCapture] (Boolean): If true, useCapture indicates that the user wishes to initiate capture. After initiating capture, all events of the specified type will be dispatched to the registered listener before being dispatched to any EventTarget beneath it in the DOM tree. Events which are bubbling upward through the tree will not trigger a listener designated to use capture.

Returns

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

Example

var input = document.getElementById('input');

var source = Rx.DOM.keypress(input);

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

Location

File:

• /src/events/events.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/events/tests.events.js