domchristie / juration

A natural language duration parser/stringifier written in javascript

Juration.js

A simple natural language duration parser written in javascript. Time ranges (in seconds) can also be converted to human readable strings. Check out the demo.

Inspired by chronic, and chronic_duration.

Usage

Parsing

juration.parse("3mins 5secs"); // returns 185

Stringifying

juration.stringify(185); // returns "3 mins 5 secs"
juration.stringify(185, { format: 'small' }); // returns "3 mins 5 secs"
juration.stringify(185, { format: 'micro' }); // returns "3m 5s"
juration.stringify(185, { format: 'long' });  // returns "3 minutes 5 seconds"
juration.stringify(185, { format: 'long', units: 1 });  // returns "3 minutes"
juration.stringify(3601, { format: 'micro', units: 2 });  // returns "1h"

Examples

Parse-able strings:

• 12.4 secs
• 3 mins 4 sec
• 2 hrs 20 min
• 2h20min
• 6 mos 1 day
• 47 yrs 6 mos and 4d
• 3 weeks and 2 days

Todo

• Add customisable default unit option, e.g. juration.parse("10", { defaultUnit: 'minutes' }) // returns 600
• Parse chrono format i.e. hh:mm:ss

Licence

Juration is copyright © 2011 Dom Christie and released under the MIT license.

juration's Issues

Parsing months in micro format fails

I use the micro format to parse back and forth. The months and minutes both use m as unit which causes issues when parsing the dates. I would like to be more compatible with general date formats which uses M for months and m for minutes.

Parse hh:mm:ss

E.g. 1:30 now parses to 31, should be 90.

Create release

Hi,

Could you please create an 'official' release for 0.0.1? Then I can point to a real version when using bower :-)

Thanks!

bower install

@domchristie First off, awesome library! I've looked high and low for something like juration.

It'd be fantastic if juration was available via bower.

Stringify incorrect for 59s changeover

console.log(juration.stringify(7198))
1 hr 59 mins 58 secs
console.log(juration.stringify(7199))
2 hrs 59 mins 59 secs

Strings with "ms" unit being parsed as minutes

juration.parse("1ms") // returns 60

Should maybe return an error?

Stringify doesn't work with time fractions

var juration = require("juration");
console.log(juration.stringify(0.2));

prints an empty string instead of "0.2 secs".
Related to #13.

Why not milliseconds?

Why not milliseconds? :(

Stringifying values >= year returns inaccurate string

Stringifying adds on 5 days per year.

1 year in seconds = 31536000

juration.stringify(31536000); // returns 1 yr 5 days