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

@risadams/time-since

v2.0.0

Published

A zero-dependency JavaScript function to calculate the elapsed time between a specified value and now.

Downloads

12

Readme

Time-Since

This project provides an enhanced JavaScript utility function timeSince that calculates the time elapsed since a given date, with support for various time units and human-readable formats in different locales. The timeSince function is useful for applications that need to display time differences in a flexible and customizable manner.

Features

  • Calculates time elapsed in various units such as years, months, days, hours, minutes, seconds, and milliseconds.
  • Supports customizable output formats (e.g., relative, milliseconds, days, etc.).
  • Utilizes Intl.RelativeTimeFormat to provide human-readable relative time in different locales.
  • Handles both string and Date object inputs.

Install

npm install @risadams/time-since

Usage

The timeSince function can be used to calculate the elapsed time from a given date and return the result in different formats. Below are some examples of how to use the function.

Example 1: Basic Usage

const timeSince = require('@risadams/time-since');

const elapsedTime = timeSince('2020-01-01');
console.log(elapsedTime);
// Output: { years: 4, months: 3, days: ..., hours: ..., minutes: ..., seconds: ..., milliseconds: ... }

Example 2: Custom Format

const elapsedDays = timeSince('2020-01-01', { format: 'days' });
console.log(elapsedDays);
// Output: 1461 (assuming the current year is 2024)

Example 3: Relative Time in Different Locales

const relativeTimeFr = timeSince('2020-01-01', { format: 'relative', locale: 'fr' });
console.log(relativeTimeFr);
// Output: "il y a 4 ans"

Running Tests

The project includes unit tests written using the Jest framework. These tests cover all major functionalities of the timeSince function, including various input formats and customizable options.

To run the tests:

npm test

The test suite includes:

  • Handling of both string and Date object inputs.
  • Validation of different time units (e.g., milliseconds, seconds, minutes, etc.).
  • Testing of relative time outputs in different locales.

Contribute

If you think this could be better, please open an issue!

Please note that all interactions in this organization fall under our Code of Conduct.

License

MIT © 1996+ Ris Adams