Safe Units

Type-safe TypeScript units of measure

Physics
jscheiny/safe-unitsjscheiny.github.io/safe-unitssafe-units

README

Safe Units


Safe Units is a type safe library for using units of measurement in TypeScript.  Safe Units provides an implementation of an SI based unit system but is flexible enough to allow users to create their own unit systems which can be independent or can interoperate with the built-in units. Users can also make unit systems for any numeric type they'd like not just the JavaScript number type. This library requires TypeScript 3.2 or higher.

  1. ```ts
  2. import { Length, Measure, meters, seconds, Time, Velocity } from "safe-units";

  4. const length: Length = Measure.of(30, meters);
  5. const time: Time = Measure.of(15, seconds);
  6. const velocity: Velocity = length.over(time);

  8. console.log(length.toString()); // 30 m
  9. console.log(time.toString()); // 15 s
  10. console.log(velocity.toString()); // 2 m * s^-1

  12. // @ts-expect-error ERROR: A measure of m*s isn't assignable to a measure of m/s.
  13. const error: Velocity = length.times(time);
  14. ```

Features


⭐  Compile-time unit arithmetic for typesafe dimensional analysis (with exponents between -5 and +5)!

⭐  Large library of predefined units including SI (with prefixes), Imperial, and US customary units!

⭐  Ability to add your own unit system that can work with built-in units!

⭐  Long build times & cryptic error messages!

Prerequisites


Safe units is written in TypeScript and should be consumed by TypeScript users to take full advantage of what it provides. In addition you will need the following:

- TypeScript 3.2 or later
- Strict null checks enabled for your project

Installation


  1. ```
  2. npm install safe-units
  3. ```

or

  1. ```
  2. yarn add safe-units
  3. ```

Examples


Unit Arithmetic


  1. ```ts
  2. import { bars, kilograms, Measure, meters, milli, seconds } from "safe-units";

  4. const width = Measure.of(3, meters);
  5. const height = Measure.of(4, meters);
  6. const area = width.times(height).scale(0.5);

  8. const mass = Measure.of(30, kilograms);
  9. const mps2 = meters.per(seconds.squared());
  10. const acceleration = Measure.of(9.8, mps2);

  12. const force = mass.times(acceleration); // 294 N
  13. const pressure = force.over(area); // 49 Pa
  14. const maxPressure = Measure.of(0.5, milli(bars)); // 0.5 mbar
  15. pressure.lt(maxPressure); // true

  17. ```

Type Errors


  1. ```ts
  2. import { Force, hours, Length, Measure, meters, seconds, Time } from "safe-units";

  4. const length: Length = Measure.of(10, meters);
  5. const time: Time = Measure.of(10, seconds);

  7. // @ts-expect-error - Measures of different units cannot be added
  8. length.plus(time);

  10. // @ts-expect-error - Measures of different units cannot be compared
  11. length.eq(time);

  13. // @ts-expect-error - Measure of m/s is not assigneable to measure of kg*m/s^2
  14. const force: Force = length.over(time);

  16. // @ts-expect-error - Cannot convert length measure to time measure
  17. length.in(hours);

  19. ```

Naming Units


  1. ```ts
  2. import { days, Measure, mega, micro, miles, speedOfLight, yards } from "safe-units";

  4. const furlongs = Measure.of(220, yards, "fur");

  6. Measure.of(8, furlongs).in(miles); // "1 mi"
  7. Measure.of(1, miles).in(furlongs); // "8 fur"

  9. const fortnights = Measure.of(14, days, "ftn");
  10. const megafurlong = mega(furlongs);
  11. const microfortnight = micro(fortnights);
  12. const mfPerUFtn = megafurlong.per(microfortnight).withSymbol("Mfur/µftn");

  14. speedOfLight.in(mfPerUFtn); // "1.8026174997852542 Mfur/µftn"

  16. ```

Deriving Quantities


  1. ```ts
  2. import { kilograms, liters, Mass, Measure, Volume } from "safe-units";

  4. const VolumeDensity = Mass.over(Volume);
  5. type VolumeDensity = typeof VolumeDensity;

  7. const mass = Measure.of(30, kilograms);
  8. const volume = Measure.of(3, liters);

  10. const density: VolumeDensity = mass.over(volume);

  12. console.log(density.toString()); // 10 kg * m^-3

  14. ```

Defining Unit Systems


  1. ```ts
  2. import { Measure, UnitSystem } from "safe-units";

  4. const GameUnitSystem = UnitSystem.from({
  5.     frames: "fr",
  6.     time: "s",
  7. });

  9. const frames = Measure.dimension(GameUnitSystem, "frames");
  10. const seconds = Measure.dimension(GameUnitSystem, "time");

  12. const Frames = frames;
  13. type Frames = typeof frames;

  15. const Time = seconds;
  16. type Time = typeof seconds;

  18. const FrameRate = Frames.over(Time);
  19. type FrameRate = typeof FrameRate;

  21. const fps: FrameRate = frames.per(seconds).withSymbol("fps");

  23. const minFrameRate = Measure.of(60, fps);

  25. const measuredFrames = Measure.of(8000, frames);
  26. const elapsedTime = Measure.of(120, seconds);
  27. const measuredFps: FrameRate = measuredFrames.over(elapsedTime);

  29. if (measuredFps.lt(minFrameRate)) {
  30.     // Optimize
  31. }

  33. ```