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

moondial

v0.1.4

Published

A tiny stopwatch, chronometer, and countdown timer library with millisecond precision built in TypeScript

Downloads

15

Readme

Moondial Timer

A tiny stopwatch, chronometer, and countdown timer library with millisecond precision built in TypeScript. Support for state change events implemented via RxJs. Use it in the browser or NodeJs.

See the docs for live examples of the library in action: http://moondial.siliconcosmos.com

Project Setup

Build the project:

> npm run build
# OR
> npm run watch

Run a demo of the project with:

> npm run demo

This demo is equivalent to the live demo in the docs.

Usage

Install the Library

> npm install moondial

Import the Library

ES Modules:

import { Clock, Duration } from "moondial.js";

Require statement:

var { Clock, Duration } = require("moondial.js");

Quickstart Example

Setup a new clock with some basic configuration.

let c = new Clock({ 
    mode: 'countdown',
    initial: Duration.of(20, 'seconds')
});

This creates a new countdown clock with an inital time of 20 seconds. If we set no configuration the mode would default to 'stopwatch' and initial time would default to 0 seconds.

We can start the clock...

c.start();

pause the clock...

c.pause();

and stop the clock. Stopping the clock will cause it to revert to initial on next start.

c.stop();

We can also reconfigure the clock later.

c.configure({ 
    mode: 'countdown',
    initial: Duration.of(10, 'minutes'),
    interval: Duration.of(100, 'milliseconds')
});

The update interval would otherwise default to 500ms.

When the clock is running (or any other phase, really) we can fetch the state.

const cState = c.state;
// Which returns:
{
    phase: 'running',
    time: {} //some Duration object
}

We can access the time in a particular unit.

cState.time.as('milliseconds'); // e.g. 9845

OR convert the time to a nice clock style string

import { Clockify } from "moondial.js";

Clockify.duration(cState.time, ['hours', 'minutes', 'seconds']);
// Which returns:
// 00:09:57

The units are not mandatory and would default to ['minutes', 'seconds']. We can also clockify other things.

// all Duration params are optional
Clockify.durationParams({ days: 1, hours: 3, minutes: 30, seconds: 10, milliseconds: 0 });
// optional separator character results in - 04;40
Clockify.seconds(280, [['minutes', 'seconds'], ';']);
// 00:10
Clockify.milliseconds(10000);

OR we could subscribe to clock updated events and do any of these things in the callback.

c.events.subscribe('updated', (state:ClockState) => {
    console.log(state.phase);
    console.log(state.time.as('milliseconds'));
    console.log(Clockify.duration(state.time));
});

The library also contains typescript definitions with doc comments for editors which support hinting.

See the docs for more examples and API details: http://moondial.siliconcosmos.com