Get unlimited public & private packages + package-based permissions with npm Pro.Get started »

readable-timespan

2.1.0 • Public • Published

readable-timespan

Build Status Coverage Status npm version license downloads

npm package to get human readable timespans

Display timespans the way we understand them:

  • 4 minutes
  • 2 weeks
  • 23 seconds
  • 5m
  • 8 months
  • ...

Install

$ npm install --save readable-timespan

Usage

import Timespan from 'readable-timespan';
 
const timespan = new Timespan();
console.log("Last seen " + timespan.parse(5 * 60 * 1000) + " ago");
// Last seen 5 minutes ago

The parse() method takes one argument: the time difference in milliseconds, and returns the closest unit rounded up.

Configuration

There are several settings that can be changed, this allows even localization in your language.

timespan.set(options)

There are several options you can set (see examples below):

  • [second, minute, hour, week, month, year]: Different strings for unit names.
  • [space]: Whether you want a space or not.
  • [pluralize]: Whether it should return an 's' at the end when the number is > 1.
import Timespan from 'readable-timespan';
 
const timespan= new Timespan({
    lessThanFirst: 'now',
    millisecond: 'ms',
    second: 's',
    minute: 'm',
    hour: 'h',
    day: 'd',
    week: 'w',
    month: 'mo',
    year: 'y',
    space: false,
    pluralize: false
});
 
// You will now get 5s instead of 5 seconds, 4m instead of 4 minutes and so on.

Disabling units

You can disable any of the units by passing false in its settings, for example to disable milliseconds:

import Timespan from 'readable-timespan';
 
const timespan= new Timespan({
    millisecond: false
});
 
// You will now get timespan.parse(50) => 'now' 

Localization

You can set it to your language by overriding the names of the units.

For example in Spanish:

import Timespan from 'readable-timespan';
 
const timespan= new Timespan({
    millisecond: 'milisegundo',
    second: 'segundo',
    minute: 'minuto',
    hour: 'hora',
    day: 'dia',
    week: 'semana',
    month: 'mes',
    year: 'año'
});
 
// You will now get '5 segundos' instead of '5 seconds', '4 minutos' instead of '4 minutes' and so on.

License

MIT © Alejandro U. Alvarez

Analytics

Install

npm i readable-timespan

DownloadsWeekly Downloads

1,695

Version

2.1.0

License

MIT

Unpacked Size

17.4 kB

Total Files

16

Last publish

Collaborators

  • avatar