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

temporal-types

v1.2.0

Published

Typescript types for time-based fields.

Downloads

612

Readme

Temporal Types

Typescript types for time-based fields

Why?

THe point of optional typing in Typescript is to provide extra context to the reader of your code. But when we want to give the type of some number of seconds, days, or any other unit of time we end up just typing it as number. But what does timeout: number mean? Often we must dig into the source code to know if that timeout is in seconds or milliseconds. When writing our own code, hopefully we do better than that by documenting the time units in a comment or in the variable name itself (i.e.: timeoutSeconds: number). Doing so is just a poor trade-off for not having proper types.

Now for use in your program, a library like js-joda may be a good choice; you can specify timeout: Duration. That's nice, but maybe a bit heavy and absolutely won't work if you want to serialize to JSON.

This library defines typescript alias types. They are still just primitives and thus work with JSON, but provide context to your declarations. So instead of:

class UnclearThing {
  duration: number; //in minutes
  walkSeconds: number;
  yearsWithCompany: number;
  lastChange: string;
}

You can write:

import {MillisecondsInMinute, Minutes, Seconds, Years} from "temporal-types";
​
class BetterThing {
  duration: Minutes;
  walkTime: Seconds;
  timeWithCompany: Years;
  lastChange: ISODateTime;
}

It's the same thing, only clearer.

FAQ

Q: Why should I introduce another dependency for a few types that I can define myself?

A: Have you defined them? Probably not. We can do such things, but often don't.

If you don't want a dependency, feel free to copy the lines into your own source.

See also....

  • temporal-constants - Constants to compute with time units without magic numbers.
  • js-joda - Complete library for date and time representation and manipulation