@fractorysolutions/safe-units/dist/measure/genericMeasureStatic.d.ts

Type-safe TypeScript units of measure

import { GenericMeasure } from "./genericMeasure";
import { BinaryFn, PrefixFn, SpreadFn } from "./genericMeasureUtils";
import { AllowedExponents, DivideUnits, DivisorUnit, ExponentiateUnit, MultiplicandUnit, MultiplyUnits, Unit } from "./unitTypeArithmetic";
export interface GenericMeasureStatic<N> {
    /** Sums a list of one or more measures, all of the same unit. */
    sum: SpreadFn<N>;
    /** Returns the smallest of a list of one or more measures. */
    min: SpreadFn<N>;
    /** Returns the largest of a list of one or more measures. */
    max: SpreadFn<N>;
    /** Static version of `left.plus(right)` */
    add: BinaryFn<N>;
    /** Static version of `left.minus(right)` */
    subtract: BinaryFn<N>;
    /** Static version of `left.times(right)` */
    multiply<L extends Unit, R extends MultiplicandUnit<L>>(left: GenericMeasure<N, L>, right: GenericMeasure<N, R>): GenericMeasure<N, MultiplyUnits<L, R>>;
    /** Static version of `left.div(right)` */
    divide<L extends Unit, R extends DivisorUnit<L>>(left: GenericMeasure<N, L>, right: GenericMeasure<N, R>): GenericMeasure<N, DivideUnits<L, R>>;
    /** Static version of `value.toThe(exp)` */
    pow<U extends Unit, E extends AllowedExponents<U>>(value: GenericMeasure<N, U>, exp: E): GenericMeasure<N, ExponentiateUnit<U, E>>;
    /**
     * Creates a function that takes a measure and applies a symbol to its prefix and scales it by a given multiplier.
     * @param prefix the prefix to add to symbols of measures passed into the resulting function
     * @param multiplier the scalar by which to multiply measures passed into the resulting function
     * @returns a function that takes measures and adds a prefix to their symbols and multiplies them by a given value
     */
    prefix(prefix: string, multiplier: N): PrefixFn<N>;
}
export declare const getGenericMeasureStaticMethods: <N>() => GenericMeasureStatic<N>;