Type alias Converter<Q, U>

Converter<Q, U>: {
to(to): _LiteralToPrimitive<Q>;
to<K>(to, kind?): BestConversion<Q, BestUnitsForUnit<U, K>>;
}

The return value from calling a conversion function.

Type Parameters

Q extends number | bigint
U extends Unit

Type declaration

to:function
- to(to): _LiteralToPrimitive<Q>
- Convert a quantity of one unit into a new unit
  Parameters
  - to: U
    The unit you want to convert to
  Returns _LiteralToPrimitive<Q>
  The converted value
  - Defined in types/converter.ts:41
- to<K>(to, kind?): BestConversion<Q, BestUnitsForUnit<U, K>>
- Convert a measurement to the best unit for display.
  Type Parameters
  - K extends BestKind = BestKind
  Parameters
  - to: "best"
    The string best
  - Optional kind: K
    The set of units to use (defaults to 'metric')
  Returns BestConversion<Q, BestUnitsForUnit<U, K>>
  An object with a quantity property of the unit unit, which can be casted to a string using the toString() method
  - Defined in types/converter.ts:50

Generated using TypeDoc