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

countdown-lib

v3.0.0

Published

A lightweight JavaScript library for efficiently counting down the time from the present to a specified future date.

Downloads

5

Readme

Countdown Library

TypeScript Vite GitHub NPM

Features

  • Written in TypeScript.
  • Can be used with any JS library or framework.
  • Uses (setInterval).
  • Easy to use callback method.
  • Return values include days, hours, minutes and seconds.

Example

import { Countdown, RemainingTimeType } from 'countdown-lib';

// Any JavaScript supported date format can be used as long as it is passed as a Date object.
const countdown = new Countdown(new Date(2023, 0, 1, 0, 0, 0));

countdown.startCounter((remainder: RemainingTimeType, isComplete: boolean) => {
  // isComplete will return false when all values are zero.
  if (!isComplete) {
    console.log(remainder);
    // Remainder should look something like this:
    // { days: 45, hours: 5, minutes: 32, seconds: 12 }
  }
});

API

// Starts a instance of setInterval that executes a callback every 1000ms with arguments
// for the remaining time and a truthy value that tells you when the countdown is complete.
countdown.startCounter(callback(remainder: RemainingTime, isComplete: boolean) => void): void;

countdown.stopCounter()

// Clears setInterval
countdown.stopCounter(): void

countdown.getRemainingTime()

// Optional method for retrieving remaining time outside of the .startCounter() callback.
// The return type can change depending on your configuration see "config" bellow.
countdown.getRemainingTime(): RemainingTime<number | string>

Config

// You can pass an optional configuration object as a second argument.
const countdown = new Countdown(new Date(2023, 0, 1, 0, 0), config);

addLeadingZeros: boolean

// Adds a left padding of 0 to all values less then 10
const countdown = new Countdown(new Date(2023, 0, 1, 0, 0), { addLeadingZeros: true });
// example: { days: 09, hours: 05, minutes: 02, seconds: 07 }