haystack-units

Haystack Unit Database

The unit database for haystack-core.

This project compiles a complete unit database that can be used an application to convert between different numerical units.

Since there are a lot of units (that an application may or may not use), the database is built into this separate library instead of haystack-core.

The database is compiled from Fantom's unit database file units which in turn is based on the unit database from oBIX.

When this module is built, the units database is parsed and compiled into TypeScript. Therefore every unit has its strongly typed with its own name.

In order for units to be successfully used with HNum either the whole unit database just the units the user is interested in must be imported.

Installation

npm install haystack-core haystack-units

APIs

Please click here for the API documentation.

Importing

To import the whole unit database into your application...

import 'haystack-units'

...or...

import units from 'haystack-units'

If you're developing an UI application that uses webpack, you may want to only import the particular units you're interested in. This will employ tree shaking to ensure only the units your application is using is built into your app...

import {second, millisecond} from 'haystack-units'

...
const msNum = secondsNum.convertTo(millisecond)

When using this approach remember to import the units you are intending to convert to (millisecond) and from (second).

Please see HNum and HUnit in haystack-core for more information.