uom-types 2.0.0 → 3.0.1

package/dist/_time-duration.d.cts

@@ -0,0 +1,482 @@
+import { b as UnknownAbstractUnit, U as UnknownUnit, l as MultiplyUnitExponents, I as Inverse, m as UnknownUnitClass, i as UnitClass, n as InverseUnitSubvalues, e as UnitSubvalues, f as UnitMeta, g as UnknownUnitMeta, h as UnitFrom, d as AbstractUnitFrom } from './_index.cjs';
+import { B as BaseUnitClass } from './_angle-plane.cjs';
+
+/**
+ * Put the given {@link Unit} to the power of 2.
+ *
+ * @group Modifiers
+ * @category General
+ * @see {@link MultiplyUnitExponents}
+ * @see {@link Cubic}
+ */
+type Square<T extends UnknownAbstractUnit | UnknownUnit> = MultiplyUnitExponents<T, 2>;
+/**
+ * Put the given {@link Unit} to the power of 3.
+ *
+ * @group Modifiers
+ * @category General
+ * @see {@link MultiplyUnitExponents}
+ * @see {@link Square}
+ */
+type Cubic<T extends UnknownAbstractUnit | UnknownUnit> = MultiplyUnitExponents<T, 3>;
+
+/**
+ * Invert the {@link Unit}.
+ *
+ * @group Modifiers
+ * @category General
+ */
+type Reciprocal<T extends UnknownAbstractUnit | UnknownUnit> = Inverse<T>;
+/**
+ * Invert the {@link UnitClass}.
+ *
+ * @group Unit Class Modifiers
+ * @category General
+ */
+type ReciprocalUnitClass<T extends UnknownUnitClass> = UnitClass<InverseUnitSubvalues<T["__uom_types__value"]>>;
+
+/**
+ * @group Unit Classes
+ * @category Kinematic
+ */
+type FrequencyUnitClass = ReciprocalUnitClass<DurationUnitClass>;
+/**
+ * @group Abstract Units
+ * @category Kinematic
+ */
+type Frequency = Reciprocal<Duration>;
+/**
+ * @group Unit Generators
+ * @category Kinematic
+ */
+type FrequencyUnit<M extends UnitSubvalues> = FrequencyUnitFrom<UnitMeta<M>>;
+/**
+ * @group Unit Generators
+ * @category Kinematic
+ */
+type FrequencyUnitFrom<M extends UnknownUnitMeta> = UnitFrom<FrequencyUnitClass, M>;
+/**
+ * A unit of {@link Frequency}.
+ *
+ * One hertz is equal to one cycle per second.
+ *
+ * @group Units
+ * @category Derived
+ * @category Kinematic
+ * @symbol `Hz`
+ */
+type Hertz = FrequencyUnit<{}>;
+/**
+ * A unit of {@link Frequency}.
+ *
+ * @group Units
+ * @category Kinematic
+ * @symbol `s⁻¹`
+ */
+type PerSecond = Hertz;
+/**
+ * A unit of {@link Frequency}.
+ *
+ * @group Units
+ * @category Kinematic
+ * @symbol `min⁻¹`
+ */
+type PerMinute = FrequencyUnit<{
+    scalar60: -1;
+}>;
+/**
+ * A unit of {@link Frequency}.
+ *
+ * @group Units
+ * @category Kinematic
+ * @symbol `hr⁻¹`
+ */
+type PerHour = FrequencyUnit<{
+    scalar60: -2;
+}>;
+/**
+ * A unit of {@link Frequency}.
+ *
+ * @group Units
+ * @category Kinematic
+ * @symbol `day⁻¹`
+ */
+type PerDay = FrequencyUnit<{
+    scalar60: -2;
+    scalar24: -1;
+}>;
+/**
+ * A unit of {@link Frequency}.
+ *
+ * @group Units
+ * @category Kinematic
+ * @symbol `wk⁻¹`
+ */
+type PerWeek = FrequencyUnit<{
+    scalar60: -2;
+    scalar24: -1;
+    scalar7: -1;
+}>;
+/**
+ * A unit of {@link Frequency}.
+ *
+ * @group Units
+ * @category Kinematic
+ * @symbol `yr⁻¹`
+ */
+type PerYear = FrequencyUnit<{
+    scalar60: -2;
+    scalar24: -1;
+    scalarDayInYear: -1;
+}>;
+
+/**
+ * @group Unit Classes
+ * @category Mechanical
+ */
+type AreaUnitClass = BaseUnitClass<{
+    Metre: 2;
+}>;
+/**
+ * @group Abstract Units
+ * @category Mechanical
+ */
+type Area = AbstractUnitFrom<AreaUnitClass>;
+/**
+ * @group Unit Generators
+ * @category Mechanical
+ */
+type AreaUnit<M extends UnitSubvalues> = AreaUnitFrom<UnitMeta<M>>;
+/**
+ * @group Unit Generators
+ * @category Mechanical
+ */
+type AreaUnitFrom<M extends UnknownUnitMeta> = UnitFrom<AreaUnitClass, M>;
+/**
+ * A unit of {@link Area} equal to 100 {@link Square}<{@link Metre}>.
+ *
+ * @group Units
+ * @category Mechanical
+ * @symbol `a`
+ */
+type Are = AreaUnit<{
+    scalar10: 2;
+}>;
+/**
+ * A unit of {@link Area} equal to 10,000 {@link Square}<{@link Metre}>.
+ *
+ * @group Units
+ * @category Mechanical
+ * @symbol `ha`
+ */
+type Hectare = AreaUnit<{
+    scalar10: 4;
+}>;
+
+/**
+ * @group Unit Classes
+ * @category Mechanical
+ */
+type EnergyUnitClass = BaseUnitClass<{
+    Kilogram: 1;
+    Metre: 2;
+    Second: -2;
+}>;
+/**
+ * @group Abstract Units
+ * @category Mechanical
+ */
+type Energy = AbstractUnitFrom<EnergyUnitClass>;
+/**
+ * @group Unit Generators
+ * @category Mechanical
+ */
+type EnergyUnit<M extends UnitSubvalues> = EnergyUnitFrom<UnitMeta<M>>;
+/**
+ * @group Unit Generators
+ * @category Mechanical
+ */
+type EnergyUnitFrom<M extends UnknownUnitMeta> = UnitFrom<EnergyUnitClass, M>;
+/**
+ * A unit of {@link Energy}.
+ *
+ * One joule is the amount of work done when an applied force of 1 newton moves
+ * through a distance of 1 metre in the direction of the force.
+ *
+ * @group Units
+ * @category Derived
+ * @category Mechanical
+ * @symbol `J`
+ */
+type Joule = EnergyUnit<{}>;
+/**
+ * A unit of {@link Energy}.
+ *
+ * @group Units
+ * @category Mechanical
+ * @symbol `W⋅s`
+ */
+type WattSecond = Joule;
+/**
+ * A unit of {@link Energy}.
+ *
+ * @group Units
+ * @category Mechanical
+ * @symbol `W⋅min`
+ */
+type WattMinute = EnergyUnit<{
+    scalar60: 1;
+}>;
+/**
+ * A unit of {@link Energy}.
+ *
+ * @group Units
+ * @category Mechanical
+ * @symbol `W⋅hr`
+ */
+type WattHour = EnergyUnit<{
+    scalar60: 2;
+}>;
+
+/**
+ * @group Unit Classes
+ * @category Mechanical
+ */
+type LengthUnitClass = BaseUnitClass<{
+    Metre: 1;
+}>;
+/**
+ * @group Abstract Units
+ * @category Mechanical
+ */
+type Length = AbstractUnitFrom<LengthUnitClass>;
+/**
+ * @group Unit Generators
+ * @category Mechanical
+ */
+type LengthUnit<M extends UnitSubvalues> = LengthUnitFrom<UnitMeta<M>>;
+/**
+ * @group Unit Generators
+ * @category Mechanical
+ */
+type LengthUnitFrom<M extends UnknownUnitMeta> = UnitFrom<LengthUnitClass, M>;
+/**
+ * A unit of {@link Length}.
+ *
+ * @group Units
+ * @category Base
+ * @category Mechanical
+ * @symbol `m`
+ */
+type Metre = LengthUnit<{}>;
+
+/**
+ * @group Unit Classes
+ * @category Mechanical
+ */
+type MassUnitClass = BaseUnitClass<{
+    Kilogram: 1;
+}>;
+/**
+ * @group Abstract Units
+ * @category Mechanical
+ */
+type Mass = AbstractUnitFrom<MassUnitClass>;
+/**
+ * @group Unit Generators
+ * @category Mechanical
+ */
+type MassUnit<M extends UnitSubvalues> = MassUnitFrom<UnitMeta<M>>;
+/**
+ * @group Unit Generators
+ * @category Mechanical
+ */
+type MassUnitFrom<M extends UnknownUnitMeta> = UnitFrom<MassUnitClass, M>;
+/**
+ * A unit of {@link Mass}.
+ *
+ * @group Units
+ * @category Base
+ * @category Mechanical
+ * @symbol `g`
+ */
+type Gram = MassUnit<{
+    scalar10: -3;
+}>;
+/**
+ * A unit of {@link Mass}.
+ *
+ * @group Units
+ * @category Mechanical
+ * @symbol `t`
+ */
+type Tonne = MassUnit<{
+    scalar10: 3;
+}>;
+
+/**
+ * @group Unit Classes
+ * @category Mechanical
+ */
+type VolumeUnitClass = BaseUnitClass<{
+    Metre: 3;
+}>;
+/**
+ * @group Unit Classes
+ * @category Mechanical
+ */
+type Volume = AbstractUnitFrom<VolumeUnitClass>;
+/**
+ * @group Unit Classes
+ * @category Mechanical
+ */
+type VolumeUnit<M extends UnitSubvalues> = VolumeUnitFrom<UnitMeta<M>>;
+/**
+ * @group Unit Classes
+ * @category Mechanical
+ */
+type VolumeUnitFrom<M extends UnknownUnitMeta> = UnitFrom<VolumeUnitClass, M>;
+/**
+ * A unit of volume.
+ *
+ * @group Units
+ * @category Mechanical
+ * @symbol `l`
+ */
+type Litre = VolumeUnit<{
+    scalar10: -3;
+}>;
+
+/**
+ * @group Unit Classes
+ * @category Thermodynamic
+ */
+type TemperatureUnitClass = BaseUnitClass<{
+    Kelvin: 1;
+}>;
+/**
+ * @group Abstract Units
+ * @category Thermodynamic
+ */
+type Temperature = AbstractUnitFrom<TemperatureUnitClass>;
+/**
+ * @group Unit Generators
+ * @category Thermodynamic
+ */
+type TemperatureUnit<M extends UnitSubvalues> = TemperatureUnitFrom<UnitMeta<M>>;
+/**
+ * @group Unit Generators
+ * @category Thermodynamic
+ */
+type TemperatureUnitFrom<M extends UnknownUnitMeta> = UnitFrom<TemperatureUnitClass, M>;
+/**
+ * A unit of {@link Temperature}.
+ *
+ * @group Units
+ * @category Base
+ * @category Thermodynamic
+ * @symbol `K`
+ */
+type Kelvin = TemperatureUnit<{}>;
+/**
+ * A unit of {@link Temperature}.
+ *
+ * This is a unit of temperature such as the freezing point of water (at one atmosphere of pressure)
+ * is 0 ℃, while the boiling point is 100 ℃.
+ *
+ * @group Units
+ * @category Thermodynamic
+ * @symbol `℃`
+ */
+type Celsius = TemperatureUnit<{
+    "offset273.15": 1;
+}>;
+
+/**
+ * @group Unit Classes
+ * @category Time
+ */
+type DurationUnitClass = BaseUnitClass<{
+    Second: 1;
+}>;
+/**
+ * @group Abstract Units
+ * @category Time
+ */
+type Duration = AbstractUnitFrom<DurationUnitClass>;
+/**
+ * @group Unit Generators
+ * @category Time
+ */
+type DurationUnit<M extends UnitSubvalues> = DurationUnitFrom<UnitMeta<M>>;
+/**
+ * @group Unit Generators
+ * @category Time
+ */
+type DurationUnitFrom<M extends UnknownUnitMeta> = UnitFrom<DurationUnitClass, M>;
+/**
+ * A unit of {@link Duration}.
+ *
+ * @group Units
+ * @category Base
+ * @category Time
+ * @symbol `s`
+ */
+type Second = DurationUnit<{}>;
+/**
+ * A unit of {@link Duration}.
+ *
+ * @group Units
+ * @category Time
+ * @symbol `min`
+ */
+type Minute = DurationUnit<{
+    scalar60: 1;
+}>;
+/**
+ * A unit of {@link Duration}.
+ *
+ * @group Units
+ * @category Time
+ * @symbol `hr`
+ */
+type Hour = DurationUnit<{
+    scalar60: 2;
+}>;
+/**
+ * A unit of {@link Duration}.
+ *
+ * @group Units
+ * @category Time
+ * @symbol `day`
+ */
+type Day = DurationUnit<{
+    scalar60: 2;
+    scalar24: 1;
+}>;
+/**
+ * A unit of {@link Duration}.
+ *
+ * @group Units
+ * @category Time
+ * @symbol `wk`
+ */
+type Week = DurationUnit<{
+    scalar60: 2;
+    scalar24: 1;
+    scalar7: 1;
+}>;
+/**
+ * A unit of {@link Duration}.
+ *
+ * @group Units
+ * @category Time
+ * @symbol `yr`
+ */
+type Year = DurationUnit<{
+    scalar60: 2;
+    scalar24: 1;
+    scalarDayInYear: 1;
+}>;
+
+export { VolumeUnit as $, Are as A, LengthUnitClass as B, Celsius as C, Day as D, EnergyUnitClass as E, FrequencyUnitClass as F, Gram as G, Hectare as H, Length as I, Joule as J, Kelvin as K, Litre as L, Metre as M, LengthUnit as N, LengthUnitFrom as O, PerMinute as P, MassUnitClass as Q, ReciprocalUnitClass as R, Square as S, Tonne as T, Mass as U, MassUnit as V, Week as W, MassUnitFrom as X, Year as Y, VolumeUnitClass as Z, Volume as _, Second as a, VolumeUnitFrom as a0, TemperatureUnit as a1, TemperatureUnitFrom as a2, DurationUnitClass as a3, Duration as a4, DurationUnit as a5, DurationUnitFrom as a6, Minute as b, Hour as c, WattMinute as d, WattHour as e, Hertz as f, PerHour as g, PerDay as h, PerWeek as i, PerYear as j, Cubic as k, Reciprocal as l, Energy as m, EnergyUnit as n, EnergyUnitFrom as o, TemperatureUnitClass as p, Temperature as q, Frequency as r, FrequencyUnit as s, FrequencyUnitFrom as t, PerSecond as u, AreaUnitClass as v, Area as w, AreaUnit as x, AreaUnitFrom as y, WattSecond as z };