npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

tiny-relative-date

v1.3.0

Published

Tiny function that provides relative, human-readable dates.

Downloads

2,498,875

Readme

Relative Date

Build Status

Tiny function that provides relative, human-readable dates.

Installation

npm install tiny-relative-date

Usage

The module returns a relativeDate function with English translations by default.

const relativeDate = require('tiny-relative-date')

The relativeDate function accepts date strings or Date objects.

relativeDate('2017-06-25 09:00') // '12 hours ago'
relativeDate(new Date()) // 'just now'

The value of "now" can also be passed as a second parameter.

const now = new Date('2017-06-25 08:00:00')
const date = new Date('2017-06-25 07:00:00')

relativeDate(date, now) // 'an hour ago'

Using a non-English locale

The tiny-relative-date module can be initialised with a locale. See the translations directory for a list of available locales.

const relativeDateFactory = require('tiny-relative-date/lib/factory')
const deTranslations = require('tiny-relative-date/translations/de')
const relativeDate = relativeDateFactory(deTranslations)

relativeDate(new Date()) // 'gerade eben'

Using a custom locale

You can also use a completely custom locale by passing a translations object instead of a locale string. Translations can be plain strings with a {{time}} placeholder, or they can be functions. See the Adding new locales section below for a list of translation keys.

const relativeDateFactory = require('tiny-relative-date/lib/factory')
const relativeDate = relativeDateFactory({
  hoursAgo: '{{time}}h ago',
  daysAgo: (days) => `${days * 24}h ago`
})

relativeDate('2017-06-25 07:00:00') // '2h ago'
relativeDate('2017-06-24 06:00:00') // '27h ago'

Contributing

Contributions are welcome! Running this project locally requires Git and Node.js.

git clone [email protected]:wildlyinaccurate/tiny-relative-date.git
cd tiny-relative-date/
npm install

Once you are set up, you can make changes to files in the src/, spec/ and translations/ directories. Build any changes you make by running

npm run build

And run the tests with

npm run test

Adding new locales

If you would like to add a new locale, please create a JSON file in the translations directory and ensure it has the following keys:

| Key | Default value ("en" locale) | |------------------------|-----------------------------| | justNow | just now | | secondsAgo | {{time}} seconds ago | | aMinuteAgo | a minute ago | | minutesAgo | {{time}} minutes ago | | anHourAgo | an hour ago | | hoursAgo | {{time}} hours ago | | aDayAgo | yesterday | | daysAgo | {{time}} days ago | | aWeekAgo | a week ago | | weeksAgo | {{time}} weeks ago | | aMonthAgo | a month ago | | monthsAgo | {{time}} months ago | | aYearAgo | a year ago | | yearsAgo | {{time}} years ago | | overAYearAgo | over a year ago | | secondsFromNow | {{time}} seconds from now | | aMinuteFromNow | a minute from now | | minutesFromNow | {{time}} minutes from now | | anHourFromNow | an hour from now | | hoursFromNow | {{time}} hours from now | | aDayFromNow | tomorrow | | daysFromNow | {{time}} days from now | | aWeekFromNow | a week from now | | weeksFromNow | {{time}} weeks from now | | aMonthFromNow | a month from now | | monthsFromNow | {{time}} months from now | | aYearFromNow | a year from now | | yearsFromNow | {{time}} years from now | | overAYearFromNow | over a year from now |