uom-types 2.0.0 → 3.0.1

package/dist/units-converters.mjs

@@ -0,0 +1,483 @@
+import { mul, div } from './functions.mjs';
+
+/**
+ * Convert {@link Radian} to {@link Degree}.
+ */
+function radiansToDegrees(angle) {
+    return mul(angle, (180 / Math.PI));
+}
+/**
+ * Convert {@link Radian} to {@link Gradian}.
+ */
+function radiansToGradians(angle) {
+    return mul(angle, (200 / Math.PI));
+}
+/**
+ * Convert {@link Radian} to {@link Turn}.
+ */
+function radiansToTurns(angle) {
+    return div(angle, Math.PI);
+}
+/**
+ * Convert {@link Degree} to {@link Radian}.
+ */
+function degreesToRadians(angle) {
+    return mul(angle, (Math.PI / 180));
+}
+/**
+ * Convert {@link Degree} to {@link Gradian}.
+ */
+function degreesToGradians(angle) {
+    return mul(angle, (10 / 9));
+}
+/**
+ * Convert {@link Degree} to {@link Turn}.
+ */
+function degreesToTurns(angle) {
+    return div(angle, 360);
+}
+/**
+ * Convert {@link Gradian} to {@link Radian}.
+ */
+function gradiansToRadians(angle) {
+    return mul(angle, (Math.PI / 400));
+}
+/**
+ * Convert {@link Gradian} to {@link Degree}.
+ */
+function gradiansToDegrees(angle) {
+    return mul(angle, (9 / 10));
+}
+/**
+ * Convert {@link Gradian} to {@link Turn}.
+ */
+function gradiansToTurns(angle) {
+    return div(angle, 400);
+}
+/**
+ * Convert {@link Turn} to {@link Radian}.
+ */
+function turnsToRadians(angle) {
+    return mul(angle, (2 * Math.PI));
+}
+/**
+ * Convert {@link Turn} to {@link Degree}.
+ */
+function turnsToDegrees(angle) {
+    return mul(angle, 360);
+}
+/**
+ * Convert {@link Turn} to {@link Gradian}.
+ */
+function turnsToGradians(angle) {
+    return mul(angle, 400);
+}
+
+/**
+ * Convert {@link Square}<{@link Metre}> to {@link Are}.
+ */
+function squareMetresToAres(area) {
+    return div(area, 100);
+}
+/**
+ * Convert {@link Square}<{@link Metre}> to {@link Hectare}.
+ */
+function squareMetresToHectares(area) {
+    return div(area, 10_000);
+}
+/**
+ * Convert {@link Are} to {@link Square}<{@link Metre}>.
+ */
+function aresToSquareMetres(area) {
+    return mul(area, 100);
+}
+/**
+ * Convert {@link Are} to {@link Hectare}.
+ */
+function aresToHectares(area) {
+    return div(area, 100);
+}
+/**
+ * Convert {@link Hectare} to {@link Square}<{@link Metre}>.
+ */
+function hectaresToSquareMetres(area) {
+    return mul(area, 10_000);
+}
+/**
+ * Convert {@link Hectare} to {@link Are}.
+ */
+function hectaresToAres(area) {
+    return mul(area, 100);
+}
+
+/**
+ * Convert {@link Second} to {@link Minute}.
+ */
+function secondsToMinutes(duration) {
+    return div(duration, 60);
+}
+/**
+ * Convert {@link Second} to {@link Hour}.
+ */
+function secondsToHours(duration) {
+    return div(duration, 3600);
+}
+/**
+ * Convert {@link Minute} to {@link Second}.
+ */
+function minutesToSeconds(duration) {
+    return mul(duration, 60);
+}
+/**
+ * Convert {@link Minute} to {@link Hour}.
+ */
+function minutesToHours(duration) {
+    return div(duration, 60);
+}
+/**
+ * Convert {@link Hour} to {@link Second}.
+ */
+function hoursToSeconds(duration) {
+    return mul(duration, 3600);
+}
+/**
+ * Convert {@link Hour} to {@link Minute}.
+ */
+function hoursToMinutes(duration) {
+    return mul(duration, 60);
+}
+/**
+ * Convert {@link Hour} to {@link Day}.
+ */
+function hoursToDays(duration) {
+    return div(duration, 24);
+}
+/**
+ * Convert {@link Day} to {@link Hour}.
+ */
+function daysToHours(duration) {
+    return mul(duration, 24);
+}
+/**
+ * Convert {@link Day} to {@link Week}.
+ */
+function daysToWeeks(duration) {
+    return div(duration, 7);
+}
+/**
+ * Convert {@link Day} to {@link Year}.
+ *
+ * This function assume that one year is equal to 365.25 Day.
+ * Use an actual date/time library if you need more control.
+ */
+function daysToYears(duration) {
+    return div(duration, 365.25);
+}
+/**
+ * Convert {@link Week} to {@link Day}.
+ */
+function weeksToDays(duration) {
+    return mul(duration, 7);
+}
+/**
+ * Convert {@link Week} to {@link Year}.
+ */
+function weeksToYears(duration) {
+    return daysToYears(weeksToDays(duration));
+}
+/**
+ * Convert {@link Year} to {@link Day}.
+ *
+ * This function assume that one year is equal to 365.25 Day.
+ * Use an actual date/time library if you need more control.
+ */
+function yearsToDays(duration) {
+    return mul(duration, 365.25);
+}
+/**
+ * Convert {@link Year} to {@link Week}.
+ */
+function yearsToWeeks(duration) {
+    return daysToWeeks(yearsToDays(duration));
+}
+
+/**
+ * Convert {@link Joule} to {@link WattMinute}.
+ */
+function joulesToWattMinutes(energy) {
+    return div(energy, 60);
+}
+/**
+ * Convert {@link Joule} to {@link WattHour}.
+ */
+function joulesToWattHours(energy) {
+    return div(energy, 3600);
+}
+/**
+ * Convert {@link WattMinute} to {@link Joule}.
+ */
+function wattMinutesToJoules(energy) {
+    return mul(energy, 60);
+}
+/**
+ * Convert {@link WattHour} to {@link Joule}.
+ */
+function wattHoursToJoules(energy) {
+    return mul(energy, 3600);
+}
+
+/**
+ * Convert {@link Hertz} to {@link PerMinute}.
+ */
+function hertzToPerMinute(frequency) {
+    return mul(frequency, 60);
+}
+/**
+ * Convert {@link Hertz} to {@link PerHour}.
+ */
+function hertzToPerHour(frequency) {
+    return mul(frequency, 3600);
+}
+/**
+ * Convert {@link PerMinute} to {@link Hertz}.
+ */
+function perMinuteToHertz(frequency) {
+    return div(frequency, 60);
+}
+/**
+ * Convert {@link PerMinute} to {@link PerHour}.
+ */
+function perMinuteToPerHour(frequency) {
+    return mul(frequency, 60);
+}
+/**
+ * Convert {@link PerHour} to {@link Hertz}.
+ */
+function perHourToHertz(frequency) {
+    return div(frequency, 3600);
+}
+/**
+ * Convert {@link PerHour} to {@link PerMinute}.
+ */
+function perHourToPerMinute(frequency) {
+    return div(frequency, 60);
+}
+/**
+ * Convert {@link PerHour} to {@link PerDay}.
+ */
+function perHourToPerDay(frequency) {
+    return mul(frequency, 24);
+}
+/**
+ * Convert {@link PerDay} to {@link PerHour}.
+ */
+function perDayToPerHour(frequency) {
+    return div(frequency, 24);
+}
+/**
+ * Convert {@link PerDay} to {@link PerWeek}.
+ */
+function perDayToPerWeek(frequency) {
+    return mul(frequency, 7);
+}
+/**
+ * Convert {@link PerDay} to {@link PerYear}.
+ *
+ * This function assume that one year is equal to 365.25 Day.
+ * Use an actual date/time library if you need more control.
+ */
+function perDayToPerYear(frequency) {
+    return mul(frequency, 365.25);
+}
+/**
+ * Convert {@link PerWeek} to {@link PerDay}.
+ */
+function perWeekToPerDay(frequency) {
+    return div(frequency, 7);
+}
+/**
+ * Convert {@link PerWeek} to {@link PerYear}.
+ */
+function perWeekToPerYear(frequency) {
+    return perDayToPerYear(perWeekToPerDay(frequency));
+}
+/**
+ * Convert {@link PerYear} to {@link PerDay}.
+ *
+ * This function assume that one year is equal to 365.25 Day.
+ * Use an actual date/time library if you need more control.
+ */
+function perYearToPerDay(frequency) {
+    return div(frequency, 365.25);
+}
+/**
+ * Convert {@link PerYear} to {@link PerWeek}.
+ */
+function perYearToPerWeek(frequency) {
+    return perDayToPerWeek(perYearToPerDay(frequency));
+}
+
+/**
+ * Convert {@link Gram} to {@link Tonne}.
+ */
+function gramsToTonnes(mass) {
+    return div(mass, 1_000_000);
+}
+/**
+ * Convert {@link Tonne} to {@link Gram}.
+ */
+function tonnesToGrams(mass) {
+    return mul(mass, 1_000_000);
+}
+
+/**
+ * @file Autogenerated File - Don't manually edit.
+ */
+/**
+ * Convert `X` to `dekaX`.
+ */
+function toDeka(value) {
+    return mul(value, 10);
+}
+/**
+ * Convert `dekaX` to `X`.
+ */
+const fromDeka = toDeci;
+/**
+ * Convert `X` to `deciX`.
+ */
+function toDeci(value) {
+    return div(value, 10);
+}
+/**
+ * Convert `deciX` to `X`.
+ */
+const fromDeci = toDeka;
+/**
+ * Convert `X` to `hectoX`.
+ */
+function toHecto(value) {
+    return mul(value, 100);
+}
+/**
+ * Convert `hectoX` to `X`.
+ */
+const fromHecto = toCenti;
+/**
+ * Convert `X` to `centiX`.
+ */
+function toCenti(value) {
+    return div(value, 100);
+}
+/**
+ * Convert `centiX` to `X`.
+ */
+const fromCenti = toHecto;
+/**
+ * Convert `X` to `kiloX`.
+ */
+function toKilo(value) {
+    return mul(value, 1000);
+}
+/**
+ * Convert `kiloX` to `X`.
+ */
+const fromKilo = toMilli;
+/**
+ * Convert `X` to `milliX`.
+ */
+function toMilli(value) {
+    return div(value, 1000);
+}
+/**
+ * Convert `milliX` to `X`.
+ */
+const fromMilli = toKilo;
+/**
+ * Convert `X` to `megaX`.
+ */
+function toMega(value) {
+    return mul(value, 1000000);
+}
+/**
+ * Convert `megaX` to `X`.
+ */
+const fromMega = toMicro;
+/**
+ * Convert `X` to `microX`.
+ */
+function toMicro(value) {
+    return div(value, 1000000);
+}
+/**
+ * Convert `microX` to `X`.
+ */
+const fromMicro = toMega;
+/**
+ * Convert `X` to `gigaX`.
+ */
+function toGiga(value) {
+    return mul(value, 1000000000);
+}
+/**
+ * Convert `gigaX` to `X`.
+ */
+const fromGiga = toNano;
+/**
+ * Convert `X` to `nanoX`.
+ */
+function toNano(value) {
+    return div(value, 1000000000);
+}
+/**
+ * Convert `nanoX` to `X`.
+ */
+const fromNano = toGiga;
+/**
+ * Convert `X` to `teraX`.
+ */
+function toTera(value) {
+    return mul(value, 1000000000000);
+}
+/**
+ * Convert `teraX` to `X`.
+ */
+const fromTera = toPico;
+/**
+ * Convert `X` to `picoX`.
+ */
+function toPico(value) {
+    return div(value, 1000000000000);
+}
+/**
+ * Convert `picoX` to `X`.
+ */
+const fromPico = toTera;
+
+/**
+ * Convert {@link Celsius} to {@link Kelvin}.
+ */
+function celsiusToKelvin(temperature) {
+    return (temperature - 273.15);
+}
+/**
+ * Convert {@link Kelvin} to {@link Celsius}.
+ */
+function kelvinToCelsius(temperature) {
+    return (temperature + 273.15);
+}
+
+/**
+ * Convert {@link Cubic}<{@link Metre}> to {@link Litre}.
+ */
+function cubicMetresToLitres(volume) {
+    return mul(volume, 1000);
+}
+/**
+ * Convert {@link Litre} to {@link Cubic}<{@link Metre}>.
+ */
+function litresToCubicMetres(volume) {
+    return div(volume, 1000);
+}
+
+export { aresToHectares, aresToSquareMetres, celsiusToKelvin, cubicMetresToLitres, daysToHours, daysToWeeks, daysToYears, degreesToGradians, degreesToRadians, degreesToTurns, fromCenti, fromDeci, fromDeka, fromGiga, fromHecto, fromKilo, fromMega, fromMicro, fromMilli, fromNano, fromPico, fromTera, gradiansToDegrees, gradiansToRadians, gradiansToTurns, gramsToTonnes, hectaresToAres, hectaresToSquareMetres, hertzToPerHour, hertzToPerMinute, hoursToDays, hoursToMinutes, hoursToSeconds, joulesToWattHours, joulesToWattMinutes, kelvinToCelsius, litresToCubicMetres, minutesToHours, minutesToSeconds, perDayToPerHour, perDayToPerWeek, perDayToPerYear, perHourToHertz, perHourToPerDay, perHourToPerMinute, perMinuteToHertz, perMinuteToPerHour, perWeekToPerDay, perWeekToPerYear, perYearToPerDay, perYearToPerWeek, radiansToDegrees, radiansToGradians, radiansToTurns, secondsToHours, secondsToMinutes, squareMetresToAres, squareMetresToHectares, toCenti, toDeci, toDeka, toGiga, toHecto, toKilo, toMega, toMicro, toMilli, toNano, toPico, toTera, tonnesToGrams, turnsToDegrees, turnsToGradians, turnsToRadians, wattHoursToJoules, wattMinutesToJoules, weeksToDays, weeksToYears, yearsToDays, yearsToWeeks };