/** Predefined options for the unit system */ declare enum System { /** For when the unit is of the primary system */ PRIMARY = "primary", /** For when the unit is of the secondary system */ SECONDARY = "secondary" } /** Measure system data */ interface MeasurementSystemData { /** The default unit to use */ default: string; /** The ratio to convert to other measurement system */ ratio: number; /** A transformation function when a simple ratio is not enough */ transform?: (arg: string | number) => number; } /** Array of supported unit definitions */ interface UnitDefinition { /** Name of the unit definition */ name: string; /** Primary measurement system data */ primary: MeasurementSystemData; /** Secondary measurement system data */ secondary?: MeasurementSystemData; /** Unit data that belongs to this unit's definition */ data: UnitData[]; } /** Single property of definitions */ interface UnitData { /** ID of the unit */ id: string; /** Whether the unit is of primary or secondary system */ system: System; /** Multiplier for the unit */ multiplier: number; /** A zero value shift to use instead of a multiplier */ valueShift?: number; /** * A unique transformation when default ratio and multiplier do not apply. * * @returns the final value returned by the convertion */ uniqueTransform?: (value: number) => string; } /** Options for the convert method */ interface ConvertOptions { /** The decimal precision to return */ precision: number; } type ExtractUnits = T[number]['data'][number]['id']; /** * All the unit definitions used by the library */ declare const definitions: [{ readonly data: [{ readonly id: "gf"; readonly multiplier: 9.80665; readonly system: System.PRIMARY; }, { readonly id: "m/s2"; readonly multiplier: 1; readonly system: System.PRIMARY; }]; readonly name: "acceleration"; readonly primary: { readonly default: "gf"; readonly ratio: 1; }; }, { readonly data: [{ readonly id: "rad"; readonly multiplier: number; readonly system: System.PRIMARY; }, { readonly id: "deg"; readonly multiplier: 1; readonly system: System.PRIMARY; }, { readonly id: "grad"; readonly multiplier: number; readonly system: System.PRIMARY; }, { readonly id: "arcmin"; readonly multiplier: number; readonly system: System.PRIMARY; }, { readonly id: "arcsec"; readonly multiplier: number; readonly system: System.PRIMARY; }]; readonly name: "angle"; readonly primary: { readonly default: "deg"; readonly ratio: 1; }; }, { readonly data: [{ readonly id: "va"; readonly multiplier: 1; readonly system: System.PRIMARY; }, { readonly id: "miva"; readonly multiplier: 0.001; readonly system: System.PRIMARY; }, { readonly id: "kva"; readonly multiplier: 1000; readonly system: System.PRIMARY; }, { readonly id: "mva"; readonly multiplier: 1000000; readonly system: System.PRIMARY; }, { readonly id: "gva"; readonly multiplier: 1000000000; readonly system: System.PRIMARY; }]; readonly name: "apparentPower"; readonly primary: { readonly default: "va"; readonly ratio: 1; }; }, { readonly data: [{ readonly id: "mm2"; readonly multiplier: 0.000001; readonly system: System.PRIMARY; }, { readonly id: "cm2"; readonly multiplier: 0.0001; readonly system: System.PRIMARY; }, { readonly id: "m2"; readonly multiplier: 1; readonly system: System.PRIMARY; }, { readonly id: "dm"; readonly multiplier: 100; readonly system: System.PRIMARY; }, { readonly id: "ha"; readonly multiplier: 10000; readonly system: System.PRIMARY; }, { readonly id: "km2"; readonly multiplier: 1000000; readonly system: System.PRIMARY; }, { readonly id: "in2"; readonly multiplier: number; readonly system: System.SECONDARY; }, { readonly id: "yd2"; readonly multiplier: 9; readonly system: System.SECONDARY; }, { readonly id: "ft2"; readonly multiplier: 1; readonly system: System.SECONDARY; }, { readonly id: "ac"; readonly multiplier: 43560; readonly system: System.SECONDARY; }, { readonly id: "mi2"; readonly multiplier: 27878400; readonly system: System.SECONDARY; }]; readonly name: "area"; readonly primary: { readonly default: "m2"; readonly ratio: 10.7639; }; readonly secondary: { readonly default: "ft2"; readonly ratio: number; }; }, { readonly data: [{ readonly id: "co"; readonly multiplier: 1; readonly system: System.PRIMARY; }, { readonly id: "mco"; readonly multiplier: 0.001; readonly system: System.PRIMARY; }, { readonly id: "mico"; readonly multiplier: 0.000001; readonly system: System.PRIMARY; }, { readonly id: "nco"; readonly multiplier: 1e-9; readonly system: System.PRIMARY; }, { readonly id: "pco"; readonly multiplier: 1e-12; readonly system: System.PRIMARY; }]; readonly name: "charge"; readonly primary: { readonly default: "co"; readonly ratio: 1; }; }, { readonly data: [{ readonly id: "a"; readonly multiplier: 1; readonly system: System.PRIMARY; }, { readonly id: "ma"; readonly multiplier: 0.001; readonly system: System.PRIMARY; }, { readonly id: "ka"; readonly multiplier: 1000; readonly system: System.PRIMARY; }]; readonly name: "current"; readonly primary: { readonly default: "a"; readonly ratio: 1; }; }, { readonly data: [{ readonly id: "b"; readonly multiplier: 1; readonly system: System.PRIMARY; }, { readonly id: "kb"; readonly multiplier: 1024; readonly system: System.PRIMARY; }, { readonly id: "mb"; readonly multiplier: 1048576; readonly system: System.PRIMARY; }, { readonly id: "gb"; readonly multiplier: 1073741824; readonly system: System.PRIMARY; }, { readonly id: "tb"; readonly multiplier: 1099511627776; readonly system: System.PRIMARY; }, { readonly id: "by"; readonly multiplier: 1; readonly system: System.SECONDARY; }, { readonly id: "kby"; readonly multiplier: 1024; readonly system: System.SECONDARY; }, { readonly id: "mby"; readonly multiplier: 1048576; readonly system: System.SECONDARY; }, { readonly id: "gby"; readonly multiplier: 1073741824; readonly system: System.SECONDARY; }, { readonly id: "tby"; readonly multiplier: 1099511627776; readonly system: System.SECONDARY; }]; readonly name: "digital"; readonly primary: { readonly default: "b"; readonly ratio: number; }; readonly secondary: { readonly default: "by"; readonly ratio: 8; }; }, { readonly data: [{ readonly id: "ea"; readonly multiplier: 1; readonly system: System.PRIMARY; }, { readonly id: "dz"; readonly multiplier: 12; readonly system: System.PRIMARY; }]; readonly name: "each"; readonly primary: { readonly default: "ea"; readonly ratio: 1; }; }, { readonly data: [{ readonly id: "j"; readonly multiplier: 1; readonly system: System.PRIMARY; }, { readonly id: "kj"; readonly multiplier: 1000; readonly system: System.PRIMARY; }, { readonly id: "wh"; readonly multiplier: 3600; readonly system: System.PRIMARY; }, { readonly id: "miwh"; readonly multiplier: 3.6; readonly system: System.PRIMARY; }, { readonly id: "kwh"; readonly multiplier: 3600000; readonly system: System.PRIMARY; }, { readonly id: "mwh"; readonly multiplier: 3600000000; readonly system: System.PRIMARY; }, { readonly id: "gwh"; readonly multiplier: 3600000000000; readonly system: System.PRIMARY; }]; readonly name: "energy"; readonly primary: { readonly default: "j"; readonly ratio: 1; }; }, { readonly data: [{ readonly id: "n"; readonly multiplier: 1; readonly system: System.PRIMARY; }, { readonly id: "kn"; readonly multiplier: 1000; readonly system: System.PRIMARY; }, { readonly id: "lbf"; readonly multiplier: 4.44822; readonly system: System.PRIMARY; }]; readonly name: "force"; readonly primary: { readonly default: "n"; readonly ratio: 1; }; }, { readonly data: [{ readonly id: "mihz"; readonly multiplier: 0.001; readonly system: System.PRIMARY; }, { readonly id: "hz"; readonly multiplier: 1; readonly system: System.PRIMARY; }, { readonly id: "khz"; readonly multiplier: 1000; readonly system: System.PRIMARY; }, { readonly id: "mhz"; readonly multiplier: 1000000; readonly system: System.PRIMARY; }, { readonly id: "ghz"; readonly multiplier: 1000000000; readonly system: System.PRIMARY; }, { readonly id: "thz"; readonly multiplier: 1000000000000; readonly system: System.PRIMARY; }, { readonly id: "rpm"; readonly multiplier: number; readonly system: System.PRIMARY; }, { readonly id: "deg/s"; readonly multiplier: number; readonly system: System.PRIMARY; }, { readonly id: "rad/s"; readonly multiplier: number; readonly system: System.PRIMARY; }]; readonly name: "frequency"; readonly primary: { readonly default: "hz"; readonly ratio: 1; }; }, { readonly data: [{ readonly id: "lx"; readonly multiplier: 1; readonly system: System.PRIMARY; }, { readonly id: "ft-cd"; readonly multiplier: 1; readonly system: System.SECONDARY; }]; readonly name: "illuminance"; readonly primary: { readonly default: "lx"; readonly ratio: number; }; readonly secondary: { readonly default: "ft-cd"; readonly ratio: 10.76391; }; }, { readonly data: [{ readonly id: "mm"; readonly multiplier: 0.001; readonly system: System.PRIMARY; }, { readonly id: "cm"; readonly multiplier: 0.01; readonly system: System.PRIMARY; }, { readonly id: "dm"; readonly multiplier: 0.1; readonly system: System.PRIMARY; }, { readonly id: "m"; readonly multiplier: 1; readonly system: System.PRIMARY; }, { readonly id: "dem"; readonly multiplier: 10; readonly system: System.PRIMARY; }, { readonly id: "hm"; readonly multiplier: 100; readonly system: System.PRIMARY; }, { readonly id: "km"; readonly multiplier: 1000; readonly system: System.PRIMARY; }, { readonly id: "in"; readonly multiplier: 12; readonly system: System.SECONDARY; }, { readonly id: "yd"; readonly multiplier: 3; readonly system: System.SECONDARY; }, { readonly id: "ft-us"; readonly multiplier: 1.000002; readonly system: System.SECONDARY; }, { readonly id: "ft"; readonly multiplier: 1; readonly system: System.SECONDARY; }, { readonly id: "fti"; readonly multiplier: 1; readonly system: System.SECONDARY; readonly uniqueTransform: (value: number) => string; }, { readonly id: "fathom"; readonly multiplier: 6; readonly system: System.SECONDARY; }, { readonly id: "mi"; readonly multiplier: 5280; readonly system: System.SECONDARY; }, { readonly id: "nmi"; readonly multiplier: 6076.12; readonly system: System.SECONDARY; }]; readonly name: "length"; readonly primary: { readonly default: "m"; readonly ratio: 3.28084; }; readonly secondary: { readonly default: "ft"; readonly ratio: number; }; }, { readonly data: [{ readonly id: "mcg"; readonly multiplier: 0.000001; readonly system: System.PRIMARY; }, { readonly id: "mg"; readonly multiplier: 0.001; readonly system: System.PRIMARY; }, { readonly id: "g"; readonly multiplier: 1; readonly system: System.PRIMARY; }, { readonly id: "kg"; readonly multiplier: 1000; readonly system: System.PRIMARY; }, { readonly id: "mt"; readonly multiplier: 1000000; readonly system: System.PRIMARY; }, { readonly id: "oz"; readonly multiplier: number; readonly system: System.SECONDARY; }, { readonly id: "lb"; readonly multiplier: 1; readonly system: System.SECONDARY; }, { readonly id: "t"; readonly multiplier: 2000; readonly system: System.SECONDARY; }]; readonly name: "mass"; readonly primary: { readonly default: "g"; readonly ratio: number; }; readonly secondary: { readonly default: "lb"; readonly ratio: 453.592; }; }, { readonly data: [{ readonly id: "min/km"; readonly multiplier: 0.06; readonly system: System.PRIMARY; }, { readonly id: "s/m"; readonly multiplier: 1; readonly system: System.PRIMARY; }, { readonly id: "min/min"; readonly multiplier: 0.0113636; readonly system: System.SECONDARY; }, { readonly id: "s/ft"; readonly multiplier: 1; readonly system: System.SECONDARY; }]; readonly name: "pace"; readonly primary: { readonly default: "s/m"; readonly ratio: 0.3048; }; readonly secondary: { readonly default: "s/ft"; readonly ratio: number; }; }, { readonly data: [{ readonly id: "ppm"; readonly multiplier: 1; readonly system: System.PRIMARY; }, { readonly id: "ppb"; readonly multiplier: 0.001; readonly system: System.PRIMARY; }, { readonly id: "ppt"; readonly multiplier: 0.000001; readonly system: System.PRIMARY; }, { readonly id: "ppq"; readonly multiplier: 1e-9; readonly system: System.PRIMARY; }]; readonly name: "partsPer"; readonly primary: { readonly default: "ppm"; readonly ratio: 0.000001; }; }, { readonly data: [{ readonly id: "w"; readonly multiplier: 1; readonly system: System.PRIMARY; }, { readonly id: "miw"; readonly multiplier: 0.001; readonly system: System.PRIMARY; }, { readonly id: "kw"; readonly multiplier: 1000; readonly system: System.PRIMARY; }, { readonly id: "mew"; readonly multiplier: 1000000; readonly system: System.PRIMARY; }, { readonly id: "gw"; readonly multiplier: 1000000000; readonly system: System.PRIMARY; }]; readonly name: "power"; readonly primary: { readonly default: "w"; readonly ratio: 1; }; }, { readonly data: [{ readonly id: "pa"; readonly multiplier: 0.001; readonly system: System.PRIMARY; }, { readonly id: "hpa"; readonly multiplier: 0.1; readonly system: System.PRIMARY; }, { readonly id: "kpa"; readonly multiplier: 1; readonly system: System.PRIMARY; }, { readonly id: "mpa"; readonly multiplier: 1000; readonly system: System.PRIMARY; }, { readonly id: "bar"; readonly multiplier: 100; readonly system: System.PRIMARY; }, { readonly id: "torr"; readonly multiplier: number; readonly system: System.PRIMARY; }, { readonly id: "psi"; readonly multiplier: 0.001; readonly system: System.SECONDARY; }, { readonly id: "ksi"; readonly multiplier: 1; readonly system: System.SECONDARY; }]; readonly name: "pressure"; readonly primary: { readonly default: "kpa"; readonly ratio: 0.00014503768078; }; readonly secondary: { readonly default: "psi"; readonly ratio: number; }; }, { readonly data: [{ readonly id: "varh"; readonly multiplier: 1; readonly system: System.PRIMARY; }, { readonly id: "mivarh"; readonly multiplier: 0.001; readonly system: System.PRIMARY; }, { readonly id: "kvarh"; readonly multiplier: 1000; readonly system: System.PRIMARY; }, { readonly id: "mvarh"; readonly multiplier: 1000000; readonly system: System.PRIMARY; }, { readonly id: "gvarh"; readonly multiplier: 1000000000; readonly system: System.PRIMARY; }]; readonly name: "reactiveEnergy"; readonly primary: { readonly default: "varh"; readonly ratio: 1; }; }, { readonly data: [{ readonly id: "var"; readonly multiplier: 1; readonly system: System.PRIMARY; }, { readonly id: "mivar"; readonly multiplier: 0.001; readonly system: System.PRIMARY; }, { readonly id: "kvar"; readonly multiplier: 1000; readonly system: System.PRIMARY; }, { readonly id: "mvar"; readonly multiplier: 1000000; readonly system: System.PRIMARY; }, { readonly id: "gvar"; readonly multiplier: 1000000000; readonly system: System.PRIMARY; }]; readonly name: "reactivePower"; readonly primary: { readonly default: "var"; readonly ratio: 1; }; }, { readonly data: [{ readonly id: "m/s"; readonly multiplier: 3.6; readonly system: System.PRIMARY; }, { readonly id: "km/h"; readonly multiplier: 1; readonly system: System.PRIMARY; }, { readonly id: "mph"; readonly multiplier: 1; readonly system: System.SECONDARY; }, { readonly id: "knot"; readonly multiplier: 1.150779; readonly system: System.SECONDARY; }, { readonly id: "ft/s"; readonly multiplier: 0.681818; readonly system: System.SECONDARY; }]; readonly name: "speed"; readonly primary: { readonly default: "km/h"; readonly ratio: number; }; readonly secondary: { readonly default: "mph"; readonly ratio: 1.609344; }; }, { readonly data: [{ readonly id: "c"; readonly multiplier: 1; readonly system: System.PRIMARY; readonly valueShift: 0; }, { readonly id: "k"; readonly multiplier: 1; readonly system: System.PRIMARY; readonly valueShift: 273.15; }, { readonly id: "f"; readonly multiplier: 1; readonly system: System.SECONDARY; readonly valueShift: 0; }, { readonly id: "r"; readonly multiplier: 1; readonly system: System.SECONDARY; readonly valueShift: 459.67; }]; readonly name: "temperature"; readonly primary: { readonly default: "c"; readonly ratio: 1; readonly transform: (celcius: string | number) => number; }; readonly secondary: { readonly default: "f"; readonly ratio: 1; readonly transform: (fahrenheit: string | number) => number; }; }, { readonly data: [{ readonly id: "ns"; readonly multiplier: 1e-9; readonly system: System.PRIMARY; }, { readonly id: "mu"; readonly multiplier: 0.000001; readonly system: System.PRIMARY; }, { readonly id: "ms"; readonly multiplier: 0.001; readonly system: System.PRIMARY; }, { readonly id: "min"; readonly multiplier: 60; readonly system: System.PRIMARY; }, { readonly id: "h"; readonly multiplier: number; readonly system: System.PRIMARY; }, { readonly id: "d"; readonly multiplier: number; readonly system: System.PRIMARY; }, { readonly id: "week"; readonly multiplier: number; readonly system: System.PRIMARY; }, { readonly id: "month"; readonly multiplier: number; readonly system: System.PRIMARY; }, { readonly id: "year"; readonly multiplier: number; readonly system: System.PRIMARY; }]; readonly name: "time"; readonly primary: { readonly default: "s"; readonly ratio: 1; }; }, { readonly data: [{ readonly id: "v"; readonly multiplier: 1; readonly system: System.PRIMARY; }, { readonly id: "mv"; readonly multiplier: 0.001; readonly system: System.PRIMARY; }, { readonly id: "kv"; readonly multiplier: 1000; readonly system: System.PRIMARY; }]; readonly name: "voltage"; readonly primary: { readonly default: "v"; readonly ratio: 1; }; }, { readonly data: [{ readonly id: "mm3"; readonly multiplier: 0.000001; readonly system: System.PRIMARY; }, { readonly id: "cm3"; readonly multiplier: 0.0001; readonly system: System.PRIMARY; }, { readonly id: "ml"; readonly multiplier: 0.0001; readonly system: System.PRIMARY; }, { readonly id: "cl"; readonly multiplier: 0.01; readonly system: System.PRIMARY; }, { readonly id: "dl"; readonly multiplier: 0.1; readonly system: System.PRIMARY; }, { readonly id: "l"; readonly multiplier: 1; readonly system: System.PRIMARY; }, { readonly id: "kl"; readonly multiplier: 1000; readonly system: System.PRIMARY; }, { readonly id: "m3"; readonly multiplier: 1000; readonly system: System.PRIMARY; }, { readonly id: "km3"; readonly multiplier: 1000000000000; readonly system: System.PRIMARY; }, { readonly id: "tsp"; readonly multiplier: number; readonly system: System.SECONDARY; }, { readonly id: "tbs"; readonly multiplier: number; readonly system: System.SECONDARY; }, { readonly id: "in3"; readonly multiplier: 0.55411; readonly system: System.SECONDARY; }, { readonly id: "fl-oz"; readonly multiplier: 1; readonly system: System.SECONDARY; }, { readonly id: "cup"; readonly multiplier: 8; readonly system: System.SECONDARY; }, { readonly id: "pnt"; readonly multiplier: 16; readonly system: System.SECONDARY; }, { readonly id: "qt"; readonly multiplier: 32; readonly system: System.SECONDARY; }, { readonly id: "gal"; readonly multiplier: 128; readonly system: System.SECONDARY; }, { readonly id: "ft3"; readonly multiplier: 957.506; readonly system: System.SECONDARY; }, { readonly id: "yd3"; readonly multiplier: 25852.7; readonly system: System.SECONDARY; }]; readonly name: "volume"; readonly primary: { readonly default: "l"; readonly ratio: 33.8140227; }; readonly secondary: { readonly default: "fl-oz"; readonly ratio: number; }; }, { readonly data: [{ readonly id: "mm3/s"; readonly multiplier: 0.000001; readonly system: System.PRIMARY; }, { readonly id: "cm3/s"; readonly multiplier: 0.0001; readonly system: System.PRIMARY; }, { readonly id: "ml/s"; readonly multiplier: 0.0001; readonly system: System.PRIMARY; }, { readonly id: "cl/s"; readonly multiplier: 0.01; readonly system: System.PRIMARY; }, { readonly id: "dl/s"; readonly multiplier: 0.1; readonly system: System.PRIMARY; }, { readonly id: "l/s"; readonly multiplier: 1; readonly system: System.PRIMARY; }, { readonly id: "l/min"; readonly multiplier: number; readonly system: System.PRIMARY; }, { readonly id: "l/h"; readonly multiplier: number; readonly system: System.PRIMARY; }, { readonly id: "kl/s"; readonly multiplier: 1000; readonly system: System.PRIMARY; }, { readonly id: "kl/min"; readonly multiplier: number; readonly system: System.PRIMARY; }, { readonly id: "kl/h"; readonly multiplier: number; readonly system: System.PRIMARY; }, { readonly id: "m3/s"; readonly multiplier: 1000; readonly system: System.PRIMARY; }, { readonly id: "m3/min"; readonly multiplier: number; readonly system: System.PRIMARY; }, { readonly id: "m3/h"; readonly multiplier: number; readonly system: System.PRIMARY; }, { readonly id: "km3/h"; readonly multiplier: 1000000000000; readonly system: System.PRIMARY; }, { readonly id: "tsp/s"; readonly multiplier: number; readonly system: System.SECONDARY; }, { readonly id: "tbs/s"; readonly multiplier: number; readonly system: System.SECONDARY; }, { readonly id: "in3/s"; readonly multiplier: 0.55411; readonly system: System.SECONDARY; }, { readonly id: "in3/min"; readonly multiplier: number; readonly system: System.SECONDARY; }, { readonly id: "in3/h"; readonly multiplier: number; readonly system: System.SECONDARY; }, { readonly id: "fl-oz/s"; readonly multiplier: 1; readonly system: System.SECONDARY; }, { readonly id: "fl-oz/min"; readonly multiplier: number; readonly system: System.SECONDARY; }, { readonly id: "fl-oz/h"; readonly multiplier: number; readonly system: System.SECONDARY; }, { readonly id: "cup/s"; readonly multiplier: 8; readonly system: System.SECONDARY; }, { readonly id: "pnt/s"; readonly multiplier: 16; readonly system: System.SECONDARY; }, { readonly id: "pnt/min"; readonly multiplier: number; readonly system: System.SECONDARY; }, { readonly id: "pnt/h"; readonly multiplier: number; readonly system: System.SECONDARY; }, { readonly id: "qt/s"; readonly multiplier: 32; readonly system: System.SECONDARY; }, { readonly id: "gal/s"; readonly multiplier: 128; readonly system: System.SECONDARY; }, { readonly id: "gal/min"; readonly multiplier: number; readonly system: System.SECONDARY; }, { readonly id: "gal/h"; readonly multiplier: number; readonly system: System.SECONDARY; }, { readonly id: "ft3/s"; readonly multiplier: 957.506; readonly system: System.SECONDARY; }, { readonly id: "ft3/min"; readonly multiplier: number; readonly system: System.SECONDARY; }, { readonly id: "ft3/h"; readonly multiplier: number; readonly system: System.SECONDARY; }, { readonly id: "yd3/s"; readonly multiplier: 25852.7; readonly system: System.SECONDARY; }, { readonly id: "yd3/min"; readonly multiplier: number; readonly system: System.SECONDARY; }, { readonly id: "yd3/h"; readonly multiplier: number; readonly system: System.SECONDARY; }]; readonly name: "volumeFlowRate"; readonly primary: { readonly default: "l/s"; readonly ratio: 33.8140227; }; readonly secondary: { readonly default: "fl-oz/s"; readonly ratio: number; }; }]; type Units = ExtractUnits; declare enum ConverterErrorType { MissingInput = "MISSING_INPUT", ValueNotNumber = "VALUE_NOT_NUMBER", FromUnitNotString = "FROM_UNIT_NOT_STRING", ToUnitNotString = "TO_UNIT_NOT_STRING", FromUnitNotSupported = "FROM_UNIT_NOT_SUPPORTED", ToUnitNotSupported = "TO_UNIT_NOT_SUPPORTED", NoDataFound = "NO_DATA_FOUND", FromUnitHasUniqueTransform = "FROM_UNIT_HAS_UNIQUE_TRANSFORM" } declare class ConverterError extends Error { /** * The type of the error that was thrown. */ readonly type: ConverterErrorType; constructor(type: ConverterErrorType, message: string); get name(): string; } /** * Converts input from one unit to another unit * * @param value The input value to convert * @param fromUnit The unit to convert from * @param toUnit The unit to convert to * @param options Options for the conversion * @returns Will return a number if the function succeeded or a string with an error message if not * @throws A {@link ConverterError `ConverterError`} with an error message and type. * @example * ```ts * convert(5, 'm', 'ft') * ``` * * @example * ```ts * convert(5, 'c', 'f', { precision: 2 }) * ``` * @public */ declare function convert(value: number, fromUnit: Units, toUnit: Units, options?: ConvertOptions): number | string; export { type ConvertOptions, ConverterError, ConverterErrorType, type MeasurementSystemData, System, type UnitData, type UnitDefinition, type Units, convert, definitions };