Backbone poller is a simple utility that allows polling on any backbone model or collection
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
test/spec
.eslintrc
.gitignore
.travis.yml
Gruntfile.js
Makefile
README.md
backbone.poller.js
backbone.poller.min.js
bower.json
package-lock.json
package.json

README.md

npm version Build Status Dependency Status

Backbone Poller

Backbone poller is a small and simple utility that allows polling on any Backbone model or collection:

  • Is 100% compliant with any Backbone model or collection.
  • Allows you to poll without extending your base backbone models or collections
  • Guarantees one poller per model/collection instance
  • Supports advanced features like delayed run and exponential backoff
  • Event driven to be compliant with Backbone's API
  • Aborts running connections on stop/destroy
  • Prevents from running conflicting requests

The annotated source code is available online.

Downloads (Right-click, and use "Save As")


Basic Usage:

// to initialize:
var poller = Backbone.Poller.get(model_or_collection);
poller.start()

// or
var poller = Backbone.Poller.get(model_or_collection).start()

// to stop:
poller.stop();

AMD loader:

require(['path/to/backbone.poller', 'path/to/Collection'], function(Poller, Collection) {
  var collection = new Collection();
  var poller = Poller.get(collection).start();
});

Advanced Optional Options:

Altering default options:

var options = {

  // default delay is 1000ms
  delay: 300,

  // run after a delayed interval. defaults to false
  // can be a boolean `true` to wait `delay` ms before starting or a number to override the wait period
  delayed: 1000,

  // do not stop the poller on error. defaults to false
  // `error` event is always fired even with this option on.
  continueOnError: true,

  // condition for keeping polling active (when this stops being true, polling will stop)
  condition: function(model){
      return model.get('active') === true;
  },

  // We can pass data to a fetch request
  data: {fields: "*", sort: "name asc"}
}
var poller = Backbone.Poller.get(model, options);

Exponential Backoff

in order to apply Exponential Backoff on the poller we can set the delay option as an array.

  • The values are of [startDelay[, maxDelay[, multiplier]]]
  • The default multiplier is 2
  • The multiplier can be used as a function that gets the current delay as a parameter and returns the next one.
Examples:
// basic
Backbone.Poller.get(model, {delay: [100]}).start();
// 100, 200, 400, 800, 1600, 3200 ...

// with maxDelay
Backbone.Poller.get(model, {delay: [100, 1000]}).start();
// 100, 200, 400, 800, 1000, 1000 ...

// another multiplier
Backbone.Poller.get(model, {delay: [100, 1000, 3]}).start();
// 100, 300, 900, 1000, 1000 ...

// custom multiplier function
Backbone.Poller.get(model, {
  delay: [
    100,
    2000,
    function (n) {
      return n * 4
    }
  ]
}).start();
// 100, 400, 1600, 2000, 2000 ...

Register event listeners:

var poller = Backbone.Poller.get(model);
poller.on('success', function(model){
  console.info('another successful fetch!');
});
poller.on('complete', function(model){
  console.info('hurray! we are done!');
});
poller.on('error', function(model){
  console.error('oops! something went wrong');
});
poller.start()

Stopping the poller:

To stop we can manually call poller.stop() or we can make the conditional function return false:

var poller = Backbone.Poller.get(model);
poller.stop() // manually stops the poller

var options = {
  condition: function(model){
      return model.get('active') === true;
  }
};
var poller = Backbone.Poller.get(model, options);
model.set('active', false); // will programmatically stop the poller

Destroying the poller

Stop the poller, remove all event listeners, and clear all references

poller.destroy();

Check status:

var isActive = poller.active() // boolean;

Alter poller options:

Altering options will stop the current running poller and will require manual start. This method removes all existing options and set the new options assigned.

var poller = Backbone.Poller.get(model, {delay: 100}).start();

// stops the poller, replaces the options, and then starts
poller.set({delay: 300}).start();

Stop and destroy all pollers

Backbone.Poller.reset();

Change Log

1.1.4

July 10th, 2017 - Diff

  • Bugfix: Moved bower to be a test dependency only

1.1.3

June 1st, 2015 - Diff

  • Bugfix: Moved bower to be a test dependency only

1.1.2

June 1st, 2015 - Diff

  • Bugfix: prevent poller from being destroyed twice

1.1.1

May 31, 2015 - Diff

  • Added a destroy method for better garbage collection

1.0.1

April 18, 2015 - Diff

  • Set the delayed parameter to be a number (as well as a boolean)

1.0.0

April 9, 2015 - Diff

0.3.0

Jun 24, 2014 - Diff

  • Updated bower dependancies

0.2.9

Jun 6, 2014 - Diff

  • Added Bower support
  • Added Support to node-style module.exports for browserify
  • Added continueOnError option
  • Added Exponential Backoff support

0.2.8

Oct 28, 2013 - Diff

  • Cleanup

0.2.7

Sep 25, 2013 - Diff

  • Added flush option to set - defaults to false
  • Moved delayed run to start function

0.2.6

Jun 21, 2013 - Diff

  • Bugfix: Stop pollings correctly
  • Minification tweaks

0.2.5

  • cleanup
  • delayed option bugfix
  • Passing the xhr object along with the error event

Copyrights

Copyright (c) 2012 Uzi Kilon, Splunk Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.