Vibrate.js

vibrate.js

/**
 * A Vibrate object for detecting and using the window.navigator.vibrate
 * function.
 * 
 * Code borrows from David Walsh's work
 * http://davidwalsh.name/vibration-api
 *    
 * @property {boolean} supported If vibrate is supported in the current context
 */

var Vibrate = (function(self) {
  self.supported = ('vibrate' in window.navigator);
  var interval = null;

  /*
   * Starts vibration for given duration
   * @param duration  Amount of time in ms to vibrate
   */
  self.startVibrate = function(duration) {
    if (self.supported) {
      window.navigator.vibrate(duration);
    }
  };

  /*
   * Clears the interval, if set, and stops any current vibration
   */
  self.stopVibrate = function() {
    if (self.supported) {
      if (interval !== null) {
        clearInterval(interval);
      }
      window.navigator.vibrate(0);
    }
  };

  /*
   * Starts a peristent vibration for the given duration and interval
   * @param duration  The amount of time to vibrate in ms
   * @param interval  The amount of timne to pause between vibrations in ms
   */
  self.startPeristentVibrate = function(duration, interval) {
    interval = window.setInterval(function() {
      startVibrate(duration);
    }, interval);
  };

  return self;
})(Vibrate || {});