Class HUnit

constructor

• new HUnit(__namedParameters): HUnit

• Parameters

  • __namedParameters: UnitData

  Returns HUnit

Readonly _isHUnit

dimensions

• get dimensions(): undefined | UnitDimensions

• Returns undefined | UnitDimensions

  The unit's dimensions or undefined if dimensionless.

ids

• get ids(): string[]

• Returns string[]

  The ids for the units.

name

• get name(): string

• Returns string

  The unit's name.

offset

• get offset(): number

• Returns number

  The unit's offset.

quantity

• get quantity(): undefined | string

• Returns undefined | string

  The unit's quantity or undefined if none available.

scale

• get scale(): number

• Returns number

  The unit's scale.

symbol

• get symbol(): string

• Returns string

  The unit's symbol.

Static quantities

• get quantities(): string[]

• Returns string[]

  A list of all the quantities available.

Static units

• get units(): readonly HUnit[]

• Returns readonly HUnit[]

  All the registered units.

convertTo

• convertTo(scalar, to): number

• Convert the unit to the new scalar.

  Parameters

  • scalar: number

    The new scalar value.

  • to: HUnit

    The new unit to convert too.

  Returns number

  The new scalar value.

divide

• divide(unit): HUnit

• Return a unit that can be used when dividing two numbers together.

  Parameters

  • unit: HUnit

    The unit to divide.

  Returns HUnit

  The unit to divide by.

  Throws

  An error if the units can't be divided.

equals

• equals(unit?): boolean

• Equality for units.

  Parameters

  • Optional unit: HUnit

    The value to compare against.

  Returns boolean

  True if the units are equal.

multiply

• multiply(unit): HUnit

• Return a unit that can be used when multiplying two numbers together.

  Parameters

  • unit: HUnit

    The unit to multiply.

  Returns HUnit

  The unit to multiply by.

  Throws

  An error if the units can't be multiplied.

toJSON

• toJSON(): UnitData

• Returns UnitData

  The unit as a JSON object.

toString

• toString(): string

• Returns string

  A string representation of a unit.

Static clearDatabase

• clearDatabase(): void

• Clear the underlying unit database.

  Returns void

Static define

• define(data): HUnit

• Defines a unit in the database.

  Parameters

  • data: HUnit | UnitData

    The unit instance or data.

  Returns HUnit

  The unit instance.

  Throws

  An error if the unit is already registered.

Static get

• get(id): undefined | HUnit

• Return a unit from the database via its id or undefined if it can't be found.

  Parameters

  • id: string

    The id of the unit to look up.

  Returns undefined | HUnit

  The unit or undefined.

Static getUnitsForQuantity

• getUnitsForQuantity(quanity): readonly HUnit[]

• Return the units for the quantity.

  Parameters

  • quanity: string

    The quantity to search for.

  Returns readonly HUnit[]

  An array of quantities. An empty array is returned if the quantity can't be found.

Static inspectDb

• inspectDb(): void

• Dump the current state of the unit database to the console output.

  Returns void

Static isApproximate

• isApproximate(a, b): boolean

• Returns true if the two numbers approximately match.

  Parameters

  • a: number

    The first number.

  • b: number

    The second number.

  Returns boolean

  True if the two numbers match.

Static parseDatabase

• parseDatabase(text): UnitData[]

• Parse the database and return all of the units.

  Parameters

  • text: string

    The text from units.txt to parse.

  Returns UnitData[]

  All parsed units.

Static parseQuantity

• parseQuantity(text): string

• Parse some text to see if contains some quantity information. Return the quantity or undefined if it can't be found.

  Parameters

  • text: string

    The text to parse.

  Returns string

  The quantity or undefined if it can't be found.

Static parseUnit

• parseUnit(text): undefined | UnitData

• Parse a line from units.txt as follows...

  unit := [";" [";" [";" ]]] names := ("," )* id := * idChar := 'a'-'z' | 'A'-'Z' | '_' | '%' | '/' | any char > 128 dim := ["" ] // no whitespace allowed ratio := base := "kg" | "m" | "sec" | "K" | "A" | "mol" | "cd" exp := scale := offset :=

  Parameters

  • text: string

    The text to parse.

  Returns undefined | UnitData

  The unit data or undefined if no unit data is found.

  Throws

  An error if unit data is found but the format is invalid.