Skip to content

Commit

Permalink
minor/docs updates, new version
Browse files Browse the repository at this point in the history
  • Loading branch information
sebastiansandqvist committed Aug 18, 2019
1 parent 388e3f5 commit 63600f2
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 23 deletions.
46 changes: 25 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,40 +2,44 @@

[![NPM version](https://img.shields.io/npm/v/s-ago.svg)](https://www.npmjs.com/package/s-ago) ![Dependencies](https://img.shields.io/david/sebastiansandqvist/s-ago.svg) [![build status](http://img.shields.io/travis/sebastiansandqvist/s-ago.svg)](https://travis-ci.org/sebastiansandqvist/s-ago) [![NPM license](https://img.shields.io/npm/l/s-ago.svg)](https://www.npmjs.com/package/s-ago)

This is the smallest, fully unit tested module to convert Date objects into human readable relative timestamps, such as '4 minutes ago', 'yesterday', or '3 months from now'.
This is the smallest, fully unit tested module to convert Date objects into human readable relative timestamps, such as '4 minutes ago', 'yesterday', 'tomorrow', or 'in 3 months'.

## Usage
```javascript
var ago = require('s-ago');

var now = new Date();
var yesterday = new Date(now - (24 * 60 * 60 * 1000));
var hoursAgo = new Date(now - (6 * 60 * 60 * 1000));
var yesterday = new Date(now - (24 * 60 * 60 * 1000));
var inADay = new Date(now + (6 * 60 * 60 * 1000));
var inSixHours = new Date(now + (6 * 60 * 60 * 1000));
var yesterday = new Date(now.getTime() - (24 * 60 * 60 * 1000));
var hoursAgo = new Date(now.getTime() - (6 * 60 * 60 * 1000));
var yesterday = new Date(now.getTime() - (24 * 60 * 60 * 1000));
var tomorrow = new Date(now.getTime() + (6 * 60 * 60 * 1000));
var inSixHours = new Date(now.getTime() + (6 * 60 * 60 * 1000));

// present
ago(now); // 'just now'

// past
ago(yesterday); // 'yesterday'
ago(hoursAgo); // '6 hours ago'

ago(inADay); // 'in a day'
// future
ago(inSixHours); // 'in 6 hours'
ago(tomorrow); // 'tomorrow'
```

Output is as follows:

Time | Output
--- | ---
Less than 1 minute | `just now`
1-2 minutes | `a minute ago`
2-46 minutes | # `minutes ago`
46 minutes - 2 hours | `an hour ago`
2-20 hours | # `hours ago`
20-48 hours | `yesterday`
2-6 days | `last week`
7-28 days | # `weeks ago`
28 days - 2 months | `last month`
2-11 months | # `months ago`
11-23 months | `last year`
2+ years | # `years ago`
Time | Output | Future output
--- | --- | ---
Less than 1 minute | `just now` | `just now`
1-2 minutes | `a minute ago` | `in a minute`
2-46 minutes | `# minutes ago` | `in # minutes`
46 minutes - 2 hours | `an hour ago` | `in an hour`
2-20 hours | # `hours ago` | `in # hours`
20-48 hours | `yesterday` | `tomorrow`
2-6 days | `last week` | `in a week`
7-28 days | `# weeks ago` | `in # weeks`
28 days - 2 months | `last month` | `in a month`
2-11 months | `# months ago` | `in # months`
11-23 months | `last year` | `in a year`
2+ years | `# years ago` | `in # years`
4 changes: 2 additions & 2 deletions index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ Usage:
var ago = require('s-ago');
var now = new Date();
var yesterday = new Date(now - (24 * 60 * 60 * 1000));
var hoursAgo = new Date(now - (6 * 60 * 60 * 1000));
var yesterday = new Date(now.getTime() - (24 * 60 * 60 * 1000));
var hoursAgo = new Date(now.getTime() - (6 * 60 * 60 * 1000));
ago(now); // 'just now'
ago(yesterday); // 'yesterday'
Expand Down

0 comments on commit 63600f2

Please sign in to comment.