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

@skywardapps/ts-united-types

v1.1.1

Published

Types and classes for tracking simple units (meters, seconds, acres, etc)

Downloads

239

Readme

ts-united-types

A library for creating, using, and tracking unit-ed numbers -- that is, 'meters', 'seconds', 'volts', etc.

Overview

Animated code example

There is a type level to this units, ensuring that you only assign like-units to like-units. It also supports tracking ratio units -- that is meters per second or pounds per square inch. It then enables switching between units either via elimination (eg. take meters per second and multiple it by a seconds value, you get meters ) or by direct conversion (eg. meters converted to feet).

const distance1 = scalar(5, 'm');	// type: UnitedScalar<'m'>
const distance2 = scalar(10, 'm');	// type: UnitedScalar<'m'>
const time  = scalar(3, 's');		// type: UnitedScalar<'s'>

// Add two scalars together.  This uses type-safety to enforce 
// unit compatibility.
const totalDistance = distance1.add(distance2); // type: UnitedScalar<'m'>
// Convert a scalar to a ratio
const rate = totalDistance.divideBy(time); // type: UnitedRatio<'m','s'>, meters/second
const metersPerSecond = rate.value;

Additionally, via importing the convert-units library, runtime conversion is enabled automatically for known units within the same category (Area, Distance, Time, etc).

const secondsToHours = converter('s', 'h');	// type: UnitConversion<'s', 'h'>
const rateInHours = rate.convertDenominator(secondsToHours); // type: UnitedRatio<'m','h'> now meters/hour and the value has changed accordingly.
const metersPerHour = rateInHours.value;

We can now handle values whose unit isn't know at build-time with the dynamicToScalar and scalarToDynamic methods.

function ConvertMyAreaValueToAcres(inputValue: number, inputUnit: string): UnitedScalar<'ac'> {
    // Will throw an exception if inputUnit isn't known or is the wrong kind of unit (in this case, not area).
    return dynamicToScalar(inputValue, inputUnit, 'ac');
    // Returning a typed scalar with the value in acres. 
}
function ConvertAcresToAnotherAreaUnit(inputValue: UnitedScalar<'ac'>, outputUnit: string): number {
    // Will throw an exception if outputUnit isn't known or is the wrong kind of unit (in this case, not area).
    return scalarToDynamic(inputValue, outputUnit); 
    // Returning the raw number of the value converted to the destination unit.
}

View the API documentation in the docs folder.