UnitConversions Variable @beta

One-stop unit conversion helpers for the built-in canonical unit set generated from @bentley/units-schema. This surface is synchronous and only supports built-in canonical unit names shipped with core-quantity. getConversion(...) returns UnitConversionProps and uses error: true as the compatibility sentinel for known-but-incompatible built-in units. convert(...) and convertValue(...) are the throwing application helpers to use when invalid conversion metadata should fail fast. isCompatible(...) is the explicit built-in compatibility check to use before applying a conversion when a non-throwing branch is preferred. For schema-defined, custom, or provider-resolved units outside that built-in set, use a UnitsProvider-based workflow instead.

Type

{ convert: (fromUnit: UnitName, toUnit: UnitName, value: number) => number, convertValue: (value: number, conversion: UnitConversionProps) => number, getConversion: (fromUnit: UnitName, toUnit: UnitName) => UnitConversionProps, isCompatible: (fromUnit: UnitName, toUnit: UnitName) => boolean }

Default Value