https://github.com/bostrt/fuzzytime.js

RETIRED
https://github.com/bostrt/fuzzytime.js

Last synced: 19 days ago
JSON representation

RETIRED

• Host: GitHub
• URL: https://github.com/bostrt/fuzzytime.js
• Owner: bostrt
• License: mit
• Created: 2013-10-29T23:07:32.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2013-11-17T03:23:34.000Z (about 11 years ago)
• Last Synced: 2024-10-29T23:37:19.384Z (2 months ago)
• Language: JavaScript
• Homepage:
• Size: 271 KB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
fuzzytime.js [![Build Status](https://travis-ci.org/bostrt/fuzzytime.js.png?branch=master)](https://travis-ci.org/bostrt/fuzzytime.js) [![NPM version](https://badge.fury.io/js/fuzzytime.png)](http://badge.fury.io/js/fuzzytime) [![devDependency Status](https://david-dm.org/bostrt/fuzzytime.js/dev-status.png)](https://david-dm.org/bostrt/fuzzytime.js#info=devDependencies)

=======

Fuzzytime.js is a JavaScript library used for generating "fuzzy" timestamps.

Sometimes it is easier to read something like "45 minutes ago" instead of "2013-05-10 11:30:38 AM", right? Fuzzytime.js lets

you do that. Also, fuzzytime.js lets you generate those "fuzzy" timestamps using templates (a.k.a format strings) like:

  - `"%h hours ago"`

  - `"%m minute`

  - or even `"%M months in the future"`.

  

Fuzzytime.js supports [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Durations) Durations (e.g. "1Y15D", "T45M", etc.) for specifying time deltas.

Install

=====

`$ npm install fuzzytime.js`

_**or**_

`$ bower install fuzzytime.js`

  

Quick Start

======

```javascript

// Create new FuzzyTime instance

var fuzzy = new FuzzyTime();

// Setup a format string to return AFTER a day has passed

fuzzy.after('%d days ago', '1D');

// Setup a format string to return BEFORE a day has passed

fuzzy.before('%h hours ago', '1D');

// Setup a format string to return AT an hour and a half

fuzzy.at('an hour and a half', 'T1.5H');

// Generate a "fuzzy" timestamps for the difference between two dates

var result = fuzzy.build(new Date('2013-10-27'), new Date('2013-10-29'));

result == "2 days ago"; // TRUE

result = fuzzy.build(new Date('2013-10-27 13:00:00'), new Date('2013-10-27 16:00:00'));

result == "3 hours ago"; // TRUE

// If no second date is provided, the current date-time is used.

// Let's pretend the current time is exactly an hour and a half ahead of the date below

result = fuzzy.build(new Date('2013-10-27 11:45:04'));

result == "an hour and a half ago"; // TRUE

```

Documentation

========

http://bostrt.github.io/fuzzytime.js/

Contribute

========

Issues: https://github.com/bostrt/fuzzytime.js/issues

Test

====

`npm install`

`npm test`