npm

Ready to take your JavaScript development to the next level? Meet npm Enterprise - the ultimate in enterprise JavaScript.Learn more »

readable-timespan

1.2.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

var timespan = require('readable-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:

  • [pluralize]: Whether it should return an 's' at the end when the number is > 1.
var timespan = require('readable-timespan');
 
timespan.set({
    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:

var timespan = require('readable-timespan');
 
timespan.set({
    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:

var timespan = require('readable-timespan');
 
timespan.set({
    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

GPLv2 © Alejandro U. Alvarez

Analytics

install

npm i readable-timespan

Downloadsweekly downloads

617

version

1.2.0

license

GPLv3

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability