hologo
TypeScript icon, indicating that this package has built-in type declarations

1.0.6 • Public • Published

logo

Build Status Code Climate Node Version Jest Prettier Downloads License

A lightweight (1 KB) library that is used to find out humanly readable time differences between now and past date

Install

$ npm install hologo

As of NPM 5.0.0, installed modules are added as a dependency by default, so the --save option is no longer used. The other save options still exist and are listed in the documentation for npm install.

When is it useful

The module will result in the same relative date outcome like StackOverflow sign-up date of users.

Example Image

Usage

Example current date: April 18, 2018 12:00:00

JavaScript

const memberFor = require('hologo');
 
memberFor.hologo('2018/04/18 11:45:00');
//=> '15 minutes'
 
memberFor.hologo('2018/04/18 11:00:00');
//=> '1 hour'
 
memberFor.hologo('2018-04-18 10:00:00');
//=> '2 hours'
 
memberFor.hologo('2018/04/17');
//=> '1 day'
 
memberFor.hologo('1522800000000'); // 04/04/2018 12:00:00 AM
//=> '14 days'
 
memberFor.hologo('2017/05/18');
//=> '11 months'
 
memberFor.hologo('2017/04/18');
//=> '1 year'
 
memberFor.hologo('04-20-2022');
//=> '0 seconds'

TypeScript

import { hologo } from 'hologo';
 
hologo('2017/03/18');
//=> '1 year, 1 month'
 
hologo('2012-02-14');
//=> '6 years, 3 months'

API

hologo(date, option)

date

Type: string

You may pass it either any valid date string or timestamp in milliseconds.

option

Type: string
Default: Date.now()

If set, it will compare to the first parameter. Otherwise, it will stick with the current date.

License

MIT © JeffMinsungKim

Package Sidebar

Install

npm i hologo

Weekly Downloads

1

Version

1.0.6

License

MIT

Unpacked Size

10.6 kB

Total Files

6

Last publish

Collaborators

  • jeffminsungkim