units-converter-ts/dist/types/index.d.ts

A simple utility library for converting units

import { Convert } from './convert';
import { IUnitDescription } from './types';
export declare const acceleration: Convert<"metric", import("./units/acceleration").accelerationUnits>;
export declare const area: Convert<import("./units/area").areaSystems, import("./units/area").areaUnits>;
export declare const angle: Convert<"metric", import("./units/angle").angleUnits>;
export declare const apparentPower: Convert<"metric", import("./units/apparentPower").apparentPowerUnits>;
export declare const charge: Convert<"metric", import("./units/charge").chargeUnits>;
export declare const current: Convert<"metric", import("./units/current").currentUnits>;
export declare const digital: Convert<import("./units/digital").digitalSystems, import("./units/digital").digitalUnits>;
export declare const energy: Convert<import("./units/energy").energySystems, import("./units/energy").energyUnits>;
export declare const force: Convert<import("./units/force").forceSystems, import("./units/force").forceUnits>;
export declare const frequency: Convert<"metric", import("./units/frequency").frequencyUnits>;
export declare const illuminance: Convert<import("./units/illuminance").illuminanceSystems, import("./units/illuminance").illuminanceUnits>;
export declare const length: Convert<import("./units/length").lengthSystems, import("./units/length").lengthUnits>;
export declare const mass: Convert<import("./units/mass").massSystems, import("./units/mass").massUnits>;
export declare const pace: Convert<import("./units/pace").paceSystems, import("./units/pace").paceUnits>;
export declare const power: Convert<"metric", import("./units/power").powerUnits>;
export declare const pressure: Convert<import("./units/pressure").pressureSystems, import("./units/pressure").pressureUnits>;
export declare const reactiveEnergy: Convert<"metric", import("./units/reactiveEnergy").reactiveEnergyUnits>;
export declare const reactivePower: Convert<"metric", import("./units/reactivePower").reactivePowerUnits>;
export declare const speed: Convert<import("./units/speed").speedSystems, import("./units/speed").speedUnits>;
export declare const temperature: Convert<import("./units/temperature").temperatureSystems, import("./units/temperature").temperatureUnits>;
export declare const time: Convert<"metric", import("./units/time").timeUnits>;
export declare const voltage: Convert<"metric", import("./units/voltage").voltageUnits>;
export declare const volume: Convert<import("./units/volume").volumeSystems, import("./units/volume").volumeUnits>;
export declare const volumeFlowRate: Convert<import("./units/volumeFlowRate").volumeFlowRateSystems, import("./units/volumeFlowRate").volumeFlowRateUnits>;
export declare const convert: {
    /**
     * Returns all available measures.
     */
    measures: () => string[];
    /**
     * Returns an array of all available units for specified measures, or all units if no measures are provided.
     *
     * @param {...string} measures - The measure(s) for which to retrieve available units.
     */
    possibilities: (...measures: string[]) => string[];
    /**
     * Returns an array of all available units. Deprecated: Use the convert.possibilities method instead.
     *
     * @deprecated This method is deprecated and will be removed in future versions. Please use the convert.possibilities method to retrieve all available units.
     */
    allPossibilities: () => string[];
    /**
     * Converts a numeric value from one unit to another within the same measure system.
     *
     * @param {string} from - The unit name to convert from (e.g., 'cm' for centimeter).
     * @param {string} to - The unit name to convert to (e.g., 'in' for inch).
     * @param {number} value - The numeric value to convert.
     * @returns {number} The converted numeric value.
     */
    convert: (from: string, to: string, value: number) => number;
    /**
     * Returns a description for the specified unit.
     *
     * @param {string} unitName - The name of the unit to describe (e.g., 'cm' for centimeter).
     */
    describe: (unitName: string) => IUnitDescription;
    /**
     * Returns an array of descriptions for units, within specified measures or for all units if no measures are provided.
     *
     * @param {...string} measures - Optional: Names of measures for which to retrieve unit descriptions.
     */
    list: (...measures: string[]) => IUnitDescription[];
};