Miss any of our Open RFC calls?Watch the recordings here! »

discrete-time

0.2.1 • Public • Published

discrete-time.js

Build Status Coverage Status API Doc

Easily step through discrete time intervals, calling functions as you go!

discrete-time builds on Moment.js and is designed to help with creating time series data.
Think of it as a loop that increments time as well as an iterator. It can be used for discrete event simulations, but is not suitable for games or other real time simulations.

Where discrete-time shines is mocking data over time for use in testing, UI design, and sales demos.

Install

npm install discrete-time

Basic Usage

var discrete_time = require('discrete-time');
var settings = { starts_at: "2016-10-31", steps: 100, time_units: "days" };

var callback = function(dt){
  console.log(dt);  // { now: [moment], step: [integer] }
};

discrete_time.run(settings, callback);

The callback function accepts one parameter for the current time in the loop. For more information see the TimeTravelerCallback definition in the API docs.

Using the TimeTraveler class

var TimeTraveler = require('discrete-time').traveler;

var settings = { starts_at: "2015-10-21", steps: 5, time_units: "years" };
var traveler = new TimeTraveler(settings);

traveler.current.step       // the current step of the time series
traveler.current.time       // the current moment of the time series

traveler.step_forward();    // manually increment by one step/time unit
traveler.step_backwards();  // manually decrement by one step/time unit

traveler.run(callback);     // steps forward through all steps in the time series

For additional information, see the API Docs

Contributing

  • Fork this repo
  • Make changes and add tests
  • Create pull request
  • ???
  • Profit

Install

npm i discrete-time

DownloadsWeekly Downloads

1

Version

0.2.1

License

MIT

Last publish

Collaborators

  • avatar