uom-types 2.0.0 → 3.0.0

package/dist/units-converters.d.cts

@@ -0,0 +1,370 @@
+import { R as Radian, D as Degree, G as Gradian, T as Turn } from './_angle-plane.cjs';
+import { S as Square, M as Metre, A as Are, H as Hectare, a as Second, b as Minute, c as Hour, D as Day, W as Week, Y as Year, J as Joule, d as WattMinute, e as WattHour, f as Hertz, P as PerMinute, g as PerHour, h as PerDay, i as PerWeek, j as PerYear, G as Gram, T as Tonne, C as Celsius, K as Kelvin, k as Cubic, L as Litre } from './_time-duration.cjs';
+import { U as UnknownUnit, M as Multiply, k as UnitConversionRate, a as Unit } from './_index.cjs';
+
+/**
+ * Convert {@link Radian} to {@link Degree}.
+ */
+declare function radiansToDegrees(angle: Radian): Degree;
+/**
+ * Convert {@link Radian} to {@link Gradian}.
+ */
+declare function radiansToGradians(angle: Radian): Gradian;
+/**
+ * Convert {@link Radian} to {@link Turn}.
+ */
+declare function radiansToTurns(angle: Radian): Turn;
+/**
+ * Convert {@link Degree} to {@link Radian}.
+ */
+declare function degreesToRadians(angle: Degree): Radian;
+/**
+ * Convert {@link Degree} to {@link Gradian}.
+ */
+declare function degreesToGradians(angle: Degree): Gradian;
+/**
+ * Convert {@link Degree} to {@link Turn}.
+ */
+declare function degreesToTurns(angle: Degree): Turn;
+/**
+ * Convert {@link Gradian} to {@link Radian}.
+ */
+declare function gradiansToRadians(angle: Gradian): Radian;
+/**
+ * Convert {@link Gradian} to {@link Degree}.
+ */
+declare function gradiansToDegrees(angle: Gradian): Degree;
+/**
+ * Convert {@link Gradian} to {@link Turn}.
+ */
+declare function gradiansToTurns(angle: Gradian): Turn;
+/**
+ * Convert {@link Turn} to {@link Radian}.
+ */
+declare function turnsToRadians(angle: Turn): Radian;
+/**
+ * Convert {@link Turn} to {@link Degree}.
+ */
+declare function turnsToDegrees(angle: Turn): Degree;
+/**
+ * Convert {@link Turn} to {@link Gradian}.
+ */
+declare function turnsToGradians(angle: Turn): Gradian;
+
+/**
+ * Convert {@link Square}<{@link Metre}> to {@link Are}.
+ */
+declare function squareMetresToAres(area: Square<Metre>): Are;
+/**
+ * Convert {@link Square}<{@link Metre}> to {@link Hectare}.
+ */
+declare function squareMetresToHectares(area: Square<Metre>): Hectare;
+/**
+ * Convert {@link Are} to {@link Square}<{@link Metre}>.
+ */
+declare function aresToSquareMetres(area: Are): Square<Metre>;
+/**
+ * Convert {@link Are} to {@link Hectare}.
+ */
+declare function aresToHectares(area: Are): Hectare;
+/**
+ * Convert {@link Hectare} to {@link Square}<{@link Metre}>.
+ */
+declare function hectaresToSquareMetres(area: Hectare): Square<Metre>;
+/**
+ * Convert {@link Hectare} to {@link Are}.
+ */
+declare function hectaresToAres(area: Hectare): Are;
+
+/**
+ * Convert {@link Second} to {@link Minute}.
+ */
+declare function secondsToMinutes(duration: Second): Minute;
+/**
+ * Convert {@link Second} to {@link Hour}.
+ */
+declare function secondsToHours(duration: Second): Hour;
+/**
+ * Convert {@link Minute} to {@link Second}.
+ */
+declare function minutesToSeconds(duration: Minute): Second;
+/**
+ * Convert {@link Minute} to {@link Hour}.
+ */
+declare function minutesToHours(duration: Minute): Hour;
+/**
+ * Convert {@link Hour} to {@link Second}.
+ */
+declare function hoursToSeconds(duration: Hour): Second;
+/**
+ * Convert {@link Hour} to {@link Minute}.
+ */
+declare function hoursToMinutes(duration: Hour): Minute;
+/**
+ * Convert {@link Hour} to {@link Day}.
+ */
+declare function hoursToDays(duration: Hour): Day;
+/**
+ * Convert {@link Day} to {@link Hour}.
+ */
+declare function daysToHours(duration: Day): Hour;
+/**
+ * Convert {@link Day} to {@link Week}.
+ */
+declare function daysToWeeks(duration: Day): Week;
+/**
+ * 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.
+ */
+declare function daysToYears(duration: Day): Year;
+/**
+ * Convert {@link Week} to {@link Day}.
+ */
+declare function weeksToDays(duration: Week): Day;
+/**
+ * Convert {@link Week} to {@link Year}.
+ */
+declare function weeksToYears(duration: Week): Year;
+/**
+ * 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.
+ */
+declare function yearsToDays(duration: Year): Day;
+/**
+ * Convert {@link Year} to {@link Week}.
+ */
+declare function yearsToWeeks(duration: Year): Week;
+
+/**
+ * Convert {@link Joule} to {@link WattMinute}.
+ */
+declare function joulesToWattMinutes(energy: Joule): WattMinute;
+/**
+ * Convert {@link Joule} to {@link WattHour}.
+ */
+declare function joulesToWattHours(energy: Joule): WattHour;
+/**
+ * Convert {@link WattMinute} to {@link Joule}.
+ */
+declare function wattMinutesToJoules(energy: WattMinute): Joule;
+/**
+ * Convert {@link WattHour} to {@link Joule}.
+ */
+declare function wattHoursToJoules(energy: WattHour): Joule;
+
+/**
+ * Convert {@link Hertz} to {@link PerMinute}.
+ */
+declare function hertzToPerMinute(frequency: Hertz): PerMinute;
+/**
+ * Convert {@link Hertz} to {@link PerHour}.
+ */
+declare function hertzToPerHour(frequency: Hertz): PerHour;
+/**
+ * Convert {@link PerMinute} to {@link Hertz}.
+ */
+declare function perMinuteToHertz(frequency: PerMinute): Hertz;
+/**
+ * Convert {@link PerMinute} to {@link PerHour}.
+ */
+declare function perMinuteToPerHour(frequency: PerMinute): PerHour;
+/**
+ * Convert {@link PerHour} to {@link Hertz}.
+ */
+declare function perHourToHertz(frequency: PerHour): Hertz;
+/**
+ * Convert {@link PerHour} to {@link PerMinute}.
+ */
+declare function perHourToPerMinute(frequency: PerHour): PerMinute;
+/**
+ * Convert {@link PerHour} to {@link PerDay}.
+ */
+declare function perHourToPerDay(frequency: PerHour): PerDay;
+/**
+ * Convert {@link PerDay} to {@link PerHour}.
+ */
+declare function perDayToPerHour(frequency: PerDay): PerHour;
+/**
+ * Convert {@link PerDay} to {@link PerWeek}.
+ */
+declare function perDayToPerWeek(frequency: PerDay): PerWeek;
+/**
+ * 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.
+ */
+declare function perDayToPerYear(frequency: PerDay): PerYear;
+/**
+ * Convert {@link PerWeek} to {@link PerDay}.
+ */
+declare function perWeekToPerDay(frequency: PerWeek): PerDay;
+/**
+ * Convert {@link PerWeek} to {@link PerYear}.
+ */
+declare function perWeekToPerYear(frequency: PerWeek): PerYear;
+/**
+ * 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.
+ */
+declare function perYearToPerDay(frequency: PerYear): PerDay;
+/**
+ * Convert {@link PerYear} to {@link PerWeek}.
+ */
+declare function perYearToPerWeek(frequency: PerYear): PerWeek;
+
+/**
+ * Convert {@link Gram} to {@link Tonne}.
+ */
+declare function gramsToTonnes(mass: Gram): Tonne;
+/**
+ * Convert {@link Tonne} to {@link Gram}.
+ */
+declare function tonnesToGrams(mass: Tonne): Gram;
+
+/**
+ * Convert `X` to `dekaX`.
+ */
+declare function toDeka<T extends UnknownUnit>(value: T): Multiply<T, UnitConversionRate<{
+    scalar10: -1;
+}>>;
+/**
+ * Convert `dekaX` to `X`.
+ */
+declare const fromDeka: typeof toDeci;
+/**
+ * Convert `X` to `deciX`.
+ */
+declare function toDeci<T extends UnknownUnit>(value: T): Multiply<T, Unit<{}, {
+    scalar10: 1;
+}>>;
+/**
+ * Convert `deciX` to `X`.
+ */
+declare const fromDeci: typeof toDeka;
+/**
+ * Convert `X` to `hectoX`.
+ */
+declare function toHecto<T extends UnknownUnit>(value: T): Multiply<T, UnitConversionRate<{
+    scalar10: -2;
+}>>;
+/**
+ * Convert `hectoX` to `X`.
+ */
+declare const fromHecto: typeof toCenti;
+/**
+ * Convert `X` to `centiX`.
+ */
+declare function toCenti<T extends UnknownUnit>(value: T): Multiply<T, Unit<{}, {
+    scalar10: 2;
+}>>;
+/**
+ * Convert `centiX` to `X`.
+ */
+declare const fromCenti: typeof toHecto;
+/**
+ * Convert `X` to `kiloX`.
+ */
+declare function toKilo<T extends UnknownUnit>(value: T): Multiply<T, UnitConversionRate<{
+    scalar10: -3;
+}>>;
+/**
+ * Convert `kiloX` to `X`.
+ */
+declare const fromKilo: typeof toMilli;
+/**
+ * Convert `X` to `milliX`.
+ */
+declare function toMilli<T extends UnknownUnit>(value: T): Multiply<T, Unit<{}, {
+    scalar10: 3;
+}>>;
+/**
+ * Convert `milliX` to `X`.
+ */
+declare const fromMilli: typeof toKilo;
+/**
+ * Convert `X` to `megaX`.
+ */
+declare function toMega<T extends UnknownUnit>(value: T): Multiply<T, UnitConversionRate<{
+    scalar10: -6;
+}>>;
+/**
+ * Convert `megaX` to `X`.
+ */
+declare const fromMega: typeof toMicro;
+/**
+ * Convert `X` to `microX`.
+ */
+declare function toMicro<T extends UnknownUnit>(value: T): Multiply<T, Unit<{}, {
+    scalar10: 6;
+}>>;
+/**
+ * Convert `microX` to `X`.
+ */
+declare const fromMicro: typeof toMega;
+/**
+ * Convert `X` to `gigaX`.
+ */
+declare function toGiga<T extends UnknownUnit>(value: T): Multiply<T, UnitConversionRate<{
+    scalar10: -9;
+}>>;
+/**
+ * Convert `gigaX` to `X`.
+ */
+declare const fromGiga: typeof toNano;
+/**
+ * Convert `X` to `nanoX`.
+ */
+declare function toNano<T extends UnknownUnit>(value: T): Multiply<T, Unit<{}, {
+    scalar10: 9;
+}>>;
+/**
+ * Convert `nanoX` to `X`.
+ */
+declare const fromNano: typeof toGiga;
+/**
+ * Convert `X` to `teraX`.
+ */
+declare function toTera<T extends UnknownUnit>(value: T): Multiply<T, UnitConversionRate<{
+    scalar10: -12;
+}>>;
+/**
+ * Convert `teraX` to `X`.
+ */
+declare const fromTera: typeof toPico;
+/**
+ * Convert `X` to `picoX`.
+ */
+declare function toPico<T extends UnknownUnit>(value: T): Multiply<T, Unit<{}, {
+    scalar10: 12;
+}>>;
+/**
+ * Convert `picoX` to `X`.
+ */
+declare const fromPico: typeof toTera;
+
+/**
+ * Convert {@link Celsius} to {@link Kelvin}.
+ */
+declare function celsiusToKelvin(temperature: Celsius): Kelvin;
+/**
+ * Convert {@link Kelvin} to {@link Celsius}.
+ */
+declare function kelvinToCelsius(temperature: Kelvin): Celsius;
+
+/**
+ * Convert {@link Cubic}<{@link Metre}> to {@link Litre}.
+ */
+declare function cubicMetresToLitres(volume: Cubic<Metre>): Litre;
+/**
+ * Convert {@link Litre} to {@link Cubic}<{@link Metre}>.
+ */
+declare function litresToCubicMetres(volume: Litre): Cubic<Metre>;
+
+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 };