Naughty Pterodactyl Maid

    This package has been deprecated

    Author message:

    please use 'cassette' instead of 'barrel'

    barrel

    0.1.0 • Public • Published

    Everyone knows that time-based things can be done with setTimeout in JavaScript:

      var doSomething = function(){ console.log("Doing something") };
      var milliseconds = 1000;
      setTimeout(doSomething, milliseconds);

    What this JavaScript library presupposes is: maybe we can shift things around a bit?

    var something = "something";
    var doer = function(thing){ console.log("Doing " + thing) };
    var milliseconds = 1000;
    var event = { time: milliseconds, data: something };

    So now we've separated our function doSomething into another function and some data that can be passed to it. We've also joined that data together with the desired timing, and called that combination an "event."

    After doing this, we can think of having a sequence of events that exists separately from the playback mechanism that performs them. Imagine, for instance:

    var sequence = [
      { time: 1000, data: "something" },
      { time: 2000, data: "something else" },
      { time: 4000, data: "something again" }
    ]

    This is where Barrel comes in, providing a Player that you can initialize with that doer, load the sequence into, and hit play:

    var player = new Barrel.Player(doer).load(sequence);
    document.getElementById('play').onclick = function(){ player.play() };
    document.getElementById('pause').onclick = function(){ player.pause() };

    So far this is all pretty abstract, but that's on purpose. With some imagination, you can use Barrel to work with timed event sequences of any kind: a dancing hamster on a web page, a loading animation, or a Node.js-ignited firework display.

    Separating things out into a player and a sequence has a few neat side-effects. Barrel doesn't do this for you, but it's relatively straightforward to write an HTML template and some CSS that transforms an event sequence into a visual representation. Additional work to make that representation interactive would result in an editor. Sequences can also be analyzed and transformed in interesting ways with the functional JavaScript tool belt of your choice.

    At this time Barrel depends on the events npm module to emit a 'tick' event at a given interval of time while playing. I haven't tried to figure out how to make it work in a browser without Browserify.

    Install

    npm i barrel

    DownloadsWeekly Downloads

    145

    Version

    0.1.0

    License

    none

    Last publish

    Collaborators

    • zachrose