https://github.com/jeffminsungkim/hologo
🗓 A lightweight library that is used to find out humanly readable time differences between now and past date
https://github.com/jeffminsungkim/hologo
date-format datetime javascript lightweight small timeago tiny typescript
Last synced: 4 months ago
JSON representation
🗓 A lightweight library that is used to find out humanly readable time differences between now and past date
- Host: GitHub
- URL: https://github.com/jeffminsungkim/hologo
- Owner: jeffminsungkim
- License: mit
- Created: 2018-04-19T09:24:05.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-03-04T02:44:29.000Z (over 6 years ago)
- Last Synced: 2025-02-08T18:03:11.609Z (4 months ago)
- Topics: date-format, datetime, javascript, lightweight, small, timeago, tiny, typescript
- Language: JavaScript
- Homepage:
- Size: 83 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
> 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.
## Usage
> Example current date: April 18, 2018 12:00:00
### JavaScript
```js
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
```ts
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](https://jeffminsungkim.com)
[NPM 5.0.0]: https://blog.npmjs.org/post/161081169345/v500
[documentation]: https://docs.npmjs.com/cli/install