easy-time

Easiest time converter ever, units are mathematical (e.g. month=30 days)


Keywords
easy, time, converter
License
TMate
Install
npm install easy-time@1.0.1

Documentation

Easy time

Tiny tool to deal with time conversions.

require('easy-time')()
//default
expire_time  =  (5).minutes
expire_time  ==  5 //true
expire_time  === 5 //false
+expire_time === 5 //true

token = jwt.sign(user, secret, { expiresInMinutes: expire_time })
key = user.email + '_token'
redis.set(key, token)
redis.expires(key, expire_time.to_seconds)

//functional
timeout = to_milliseconds(minutes(2))
setTimeout(function () {
	console.log(to_seconds(timeout) + ' seconds have passed');
}, timeout);

To install with npm use:

$ npm install easy-time

Then import with:

  • Node
require('easy-time')(options)
//or
require('easy-time/functional')(options)
  • Web
<script src="scripts/easy-time.min.js"></script>

Options

Singular

  • singular : Boolean
  • default : false

Includes singular version of getters

Example:
  • Node
require('easy-time')({singular:true});

console.log((1).hour.to_seconds);
  • Web
<script src="scripts/easy-time.min.js" singular="true"></script>
<script type="text/javascript">console.log((1).hour.to_seconds);</script>

Table

  • table : Array<String>
  • default : ['milliseconds', 'seconds', 'minutes', 'hours', 'days', 'months', 'years']

Include units starting from milliseconds going to the next unit each time. Weeks, centuries and greater units than centuries are excluded by default. You can give your own names if you find the originals redundant.

Example:
  • Node
require('easy-time')({table:['msec', 'sec', 'min']});

console.log(12..min.to_msec);
  • Web
<script src="scripts/easy-time.min.js" table="msec sec min"></script>
<script type="text/javascript">console.log(12..min.to_msec);</script>