Javascript-timeframe

Localize date formatting, both past and present in human readable format

It format date in readable format

Example:

• 1 minute ago
• 2 months ago
• in 3 months
• just now
• 4 years ago

Install

Option A. NPM install

npm install javascript-timeframe --save

Option B. Use CDN

You can load timeline directly from jsDelivr CDN.

https://cdn.jsdelivr.net/gh/johnerry/javascript-timeframe/src/timeframe.js

For example, place this in your HTML:

<script src="https://cdn.jsdelivr.net/gh/johnerry/javascript-timeframe/src/timeframe.js"></script>

Option C. Use CDN

Copy the timeframe.js file containing only few lines of code to your project, and load it.

<script src="timeframe.js"></script>

Use

import {timeFrame} from 'javascript-timeframe'

const date = new timeFrame('2020-05-17T03:24:00');
//const date = new timeFrame(1589682240); unix

date.startingDate('2020-01-10T04:04:05');

// date.language('es');  spanish

date.language('en');  // english

console.log( date.moment() );
//  in 4 months

console.log( date.unix() );
//  1589682240

new timeFrame()  accepts all argument that a regular Date method can, including unix time digit.

if you do not specify a startingDate, timeFrame automatically uses the current time for comparison.

Other functionality

const date = new timeFrame('2020-05-17T23:24:00');
  
  console.log( date.now() );
  // returns the current milliseconds rather that the argument passed into timeFrame
  //  1611501800638
  
  console.log( date.unix() );
  // 1589754240
  // returns unix time interger of passed argument since january 1st 1970
  
  console.log( date.milliseconds() );
  // 0
  // returns milliseconds of passed argument

 console.log( date.seconds() );
 // 0
 // returns seconds in passed argument
 
 console.log( date.minutes() );
 // 24
 //returns minutes in passed argument
 
 console.log ( date.hours().long(), date.hours().short() );
 // 23, 11
 //returns hours in passed argument
 
 console.log( date.day() );
 // 17
 //return the day in passed argument
 
 console.log( date.month() );
 // May
  //return the month in the passed argument
 
 console.log( date.year() );
 // 2020
  //return the year in passed argument

Locales

Library lets you format date and time in your local language.

If no argument is matched, the "default language" is used, and the default language is "en" by default.

const date = new timeFrame('2020-05-17T03:24:00');

date.language('en'); // English
  
date.language('ru'); // Russian

date.language('es');  // Spanish

date.language('de');  // German

date.language('th');  // Thai

  // search for your language short code and pass it in. The last language code passed will be used.

Future

When future date are provided, moment()  return results like:

const date = new timeFrame('2021-05-17T03:24:00');
  console.log( date.moment() );
  //  in 3 months

License

MIT