Type Alias Quantity<Q>

Defines the properties and available units for a physical quantity.

type Quantity<Q extends PhysicalQuantity> = {
    baseUnit: BaseUnitSymbols<Q>;
    dimension?: {
        name: string;
        si: Q extends SIDimension ? true : false;
        symbol: string;
        vector: DimensionVector;
    };
    units: { [U in BaseUnitSymbols<Q>]: Unit<Q, U> };
}

Type Parameters

Q extends PhysicalQuantity
The physical quantity being defined.

Index

Properties

baseUnit dimension? units

Properties

baseUnit

baseUnit: BaseUnitSymbols<Q>

The reference unit symbol for this quantity.

`Optional`dimension

dimension?: {
    name: string;
    si: Q extends SIDimension ? true : false;
    symbol: string;
    vector: DimensionVector;
}

The physical dimension of the quantity.

Type Declaration

name: string
The full name of the dimension (e.g., "length").
si: Q extends SIDimension ? true : false
Whether this is a fundamental SI base dimension.
symbol: string
The shorthand symbol for the dimension (e.g., "L" for length).
vector: DimensionVector
The exponents of the base SI dimensions.

units

units: { [U in BaseUnitSymbols<Q>]: Unit<Q, U> }

A collection of all valid units for this quantity.