timeproxy

Simple library for time constants

Now with template literal support

Creating time constants can be a pain. You want to name them after what they are, like SESSION_TIMEOUT or MAX_REQUESTS, but you also want to make sure the code reflects how long of a period it is. Meet timeproxy.

Using some quite clever ES2015 proxies, you can now have both.

Usage

npm install timeproxy

timeproxy works by parsing the name of the "constant" you specify and returning the amount of milliseconds you require.

import tp from 'timeproxy';

const TIMEOUT_LIMIT = tp.FIVE_SECONDS;
const AGE_LIMIT = tp.ONE_WEEK_AND_SIX_DAYS;

If you prefer, you can use template literals instead:

import tp from 'timeproxy';

const TIMEOUT_LIMIT = tp`five seconds`;
const AGE_LIMIT = tp`1 week and 6 days`;
const SESSION_TIMEOUT = tp`${60} minutes`;

There's support for seconds, minutes, hours, days and weeks. You can even write fractions!

Here's a few examples of what you can do:

import tp from 'timeproxy';

const REQUEST_TIMEOUT = tp.THIRTY_SECONDS;
const UPDATE_DELAY = tp.HALF_A_SECOND;
const COOKIE_EXPIRATION = tp.FOUR_WEEKS;
const IN_ALMOST_A_MINUTE = tp.IN_FIFTY_NINE_SECONDS;

const REQUEST_TIMEOUT = tp`thirty seconds`;
const UPDATE_DELAY = tp`.5 seconds`;
const COOKIE_EXPIRATION = tp`4 weeks`;
const IN_ALMOST_A_MINUTE = tp`IN_59-SEconds`;

I've written a blog post about this as well - please refer to it for more examples.

Contribute!

If there are features you'd like to see in this tiny library, please let me know through an issue. If you feel up for it, please create a pull request and I'll make sure to look at it as soon as possible.