chronoparse v1.0.0

chronoparse

chronoparse is a simple nodejs module designed for parsing user-input timespan strings.
Currently it supports the format:

<quantity> <timespan>

Where <quantity> is a non-negative integer, and <timespan> is one of the following:

second, seconds, s
minute, minutes, m
hour, hours, h
day, days, d
week, weeks, w
month, months
year, years, y
decade, decades

chronoparse parses the given string, and returns an object using the following schema:

{
    totalSeconds, // an integer representing the total length of the timespan in seconds
    startDate, // the current datetime as of parsing completion
    endDate, // a datetime totalSeconds from startDate
    timezone, // the current local timezone, specified as "UTC+/-X" where X is the offset in hours
    parts // an array of each timespan string parsed
}

Usage

chronoparse exports a single function, called parse. This function takes a string to be parsed, and an optional options object.

const chronoparse = require("chronoparse");

let result1 = chronoparse("13 days");

console.log(result1.totalSeconds);
// expected output: 1123200

let result2 = chronoparse("2 minutes 3 seconds");

console.log(result2.totalSeconds);
// expected output: 123

The options object may contain any or all of the following options:

{
    delimiter, // a string to use to separate multiple timespans, defaults to whitespace
    max // a non-negative integer specifying the maximum number of timespans to parse in the string, defaults to no limit
}

Delimiters

chronoparse can handle compound timespans, such as 2 hours 20 minutes 14 seconds however, by default, it expects multiple timespans to be separated by only whitespace. If you wish to use other delimiters, such as commas, you should use the delimiter option:

let result = chronoparse("2 minutes, 3 seconds", {delimiter: ","});

console.log(result.totalSeconds);
// expected output: 123

Note that the trailing space after the delimiter does not need to be specified in the options object, as chronoparse will automatically trim whitespace from the start of the string before attempting to parse the next timespan.

Max timespans

In some situations, you may wish to only parse a certain number of timespans from the string. In such situations, you should use the max option:

let result = chronoparse("1 hour, 2 minutes, 3 seconds", { delimiter: ",", max: 2 });

console.log(result.totalSeconds);
// expected output: 3720

chronoparse will parse only the first max timespans in a string, and will stop parsing after it has parsed max timespans. This means that your string may contain anything, including invalid timespans, after max valid timespans, however this is not recommended.

let result = chronoparse("1 hour, 2 minutes, 3 is the coolest number", { delimiter: ",", max: 2 });

console.log(result.totalSeconds);
// expected output: 3720

NOTE: The default value of max is -1. This is interpreted as "no limit".

License and Usage

chronoparse is licensed under the MIT License, meaning it is provided as-is, and can be used freely for any purposes, commercial or otherwise. See LICENSE for the full license.