Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
create a readable stream of dom events given an element
JavaScript
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
LICENSE.mit
README.md
example.js
index.js
package.json
test.js

README.md

dom-event-stream

A streams2-compatible stream of DOMEvents over time.

var events = require('dom-event-stream')

var replace = require('dom-replace-html-stream')

events(document.querySelector('#source'), 'keyup')
  .pipe(replace(document.querySelector('#source')))

API

events(DOMElement, eventName, eventStreamOptions={}) -> EventStream

Create a readable stream of DOMEvents intercepted by DOMElement for eventName.

eventStreamOptions

The options available are as follows:

  • useCapture: determines whether the bound event listener will be in capture mode or not.
  • preventDefault: A boolean or a function accepting a DOMEvent and returning a boolean value.
  • stopPropagation: A boolean or a function accepting a DOMEvent and returning a boolean value.

EventStream#close -> undefined

Close the stream and remove the EventHandler from the DOM.

License

MIT

Something went wrong with that request. Please try again.