UnitListclass

new UnitList<K>(units: ImmutableObject<K, UnitProps<K>>)
ParamType
unitsImmutableObject<K, UnitProps<K>>
Any readonly object. required
Return
UnitList<K>
Represent a list of related units of measure (e.g. all length units).
PropertyType
.baseUnit<K>
Base unit for this list (the first unit added). required readonly

Represent a list of related units of measure (e.g. all length units).

  • Has a known base unit at .base
  • Can get required units from .unit()
  • Cannot have additional units added after it is created.

Methods

Go

UnitList.convert()method

Convert an amount from a unit in this list to another unit in this list.

convert(amount: number, sourceKey: K, targetKey: K): number
Go

UnitList.require()method

Require a unit from this list.

require(key: K): Unit<K>