cancel the jump animation

[bretkikehara]

When jump is called expose the cancel handler to stop the animation.

Tries to solve #7 without external dependencies or extra event handlers

[bretkikehara]

btw, if anyone is interested in trying this PR...

$ npm install [email protected]

var jumper = require('jump.js-cancelable');
jumper.jump(...);
jumper.cancel();

[callmecavs]

@bretkikehara havent had time to look closely at the changes to the source, but do think this is the best approach - no event listeners, just giving the user a function to cancel the jump as they see fit.

will take a look when I get the chance - thanks for the submission and taking the initiative on this one.

[bretkikehara]

So after using this a bit more, I found that exposing the timeStart is crucial to knowing the appropriate instance to cancel a jump.

https://jsfiddle.net/p5LL5fc4/

[cvlab]

@bretkikehara Thanks, very useful patch! Minor changes:
Instead of

  return {
    jump,
    cancel,
    isJumping,
  };

I'd like to see

	jump.cancel = cancel;
	jump.isJumping = isJumping;

	// expose only the jump method
	return jump

jump('.target')
jump.cancel()

this will not break existing API, or much better:

function jump(target, options = {}) {
	...
	return {cancel, isJumping}
}

let myJump1 = jump('.target1', {container: '#container1'})
let myJump2 = jump('.target2', {container: '#container2'})
...
myJump1.cancel()

because with custom container support, I think, will be possible to run a few jumps simultaneously.