--- layout: posts title: Api - units Namespace ---

Index

Functions

Functions

conversionScale

conversionScale(srcUnitType: string, destUnitType: string): number

- Defined in src/maker.js/packages/maker.js/src/core/units.ts:58
Get a conversion ratio between a source unit and a destination unit.

Parameters
- srcUnitType: string
  
  unitType converting from.
- destUnitType: string
  
  unitType converting to.
Returns number

Numeric ratio of the conversion.

isValidUnit

isValidUnit(tryUnit: string): boolean

- Defined in src/maker.js/packages/maker.js/src/core/units.ts:86
Check to see if unit type is a valid Maker.js unit.

Parameters
- tryUnit: string
  
  unit type to check.
Returns boolean

Boolean true if unit type is valid.

Generated using TypeDoc