Function valueConverter

  • valueConverter<T>(value, to): string

  • Transform the value object into a formatted string converting it to the specified unit with the unit's symbol appended

    The returned value is formatted using FixedPointNumber#getDisplayValue and is without any unit symbols or label

    Type Parameters

    Parameters

    • value: Value<string>

      The value object to be formatted

    • to: Unit<T>

      The unit to convert into, must be compatible with the value object's unit

    Returns string

    The formatted value with the unit's symbol appended

    Example

     const value = { value: 1, unit: "m/s" };
     const toUnit = "mm/s";
     const convertedValue = valueConverter(value, toUnit);
     console.log(convertedValue); // outputs "1000 mm/s"

    Throws

    Error if the value object and the provided unit are incompatible

Settings

Member Visibility