@oliasoft-open-source/units 4.2.5 → 4.3.0-beta-1

package/dist/index.d.ts

@@ -1,8 +1,399 @@
-import { label, showAltUnitsList, getAltUnitsListByQuantity, checkAndCleanDecimalComma, unitFromKey, to, split, unum, toBase, altUnitsList, convertTable, roundNumberWithLabel, withUnit, unumWithUnit, validateAndClean, isValueWithUnit, getValue, getUnit, convertSamePrecision, convertAndGetValue, convertAndGetValueStrict, getUnitsForQuantity, getQuantities, unitFromQuantity, withPrettyUnitLabel, validateNumber } from './units';
-import { ALT_UNITS, LABELS, UNIT_FROM_KEY, KNOWN_CONVERSIONS, DEPRECATED_UNITS, UNIT_ALIASES, INTERMEDIATE_CONVERSIONS, KNOWN_UNITS, QUANTITIES_DESCRIPTION, UNITS_DESCRIPTION } from './constants';
-import { isNumeric, isNonNumerical, isEmptyValueWithUnit, allNumbers, formatNumber, charCount, getNumberOfDigitsToShow, fraction, isFraction, asFraction, numFraction, cleanNumStr, cleanNum, stripLeadingZeros } from './utils';
-import { toNum, toString, isValidNum, isScientificStringNum } from './numbers/numbers';
-import { displayNumber, displayNumberToFixed } from './numbers/display-number';
-import { round, roundToFixed, roundToPrecision, roundToDecimalPrecision, roundByMagnitude, roundByMagnitudeToFixed, roundByRange } from './rounding/rounding';
-import { isCloseTo, isDeepCloseTo, isCloseToOrLessThan, isCloseToOrGreaterThan } from './comparison/comparison';
-export { label, showAltUnitsList, getAltUnitsListByQuantity, getUnitsForQuantity, getQuantities, checkAndCleanDecimalComma, unitFromKey, unitFromQuantity, to, split, unum, toBase, altUnitsList, convertTable, roundNumberWithLabel, withUnit, unumWithUnit, validateAndClean, isValueWithUnit, getValue, getUnit, convertSamePrecision, convertAndGetValue, convertAndGetValueStrict, withPrettyUnitLabel, validateNumber, round, roundToFixed, roundToPrecision, roundToDecimalPrecision, roundByMagnitude, roundByMagnitudeToFixed, roundByRange, isCloseTo, isDeepCloseTo, isCloseToOrLessThan, isCloseToOrGreaterThan, isNumeric, isNonNumerical, isEmptyValueWithUnit, allNumbers, formatNumber, displayNumber, displayNumberToFixed, charCount, getNumberOfDigitsToShow, fraction, isFraction, asFraction, numFraction, cleanNumStr, cleanNum, toNum, toString, isValidNum, isScientificStringNum, stripLeadingZeros, ALT_UNITS, LABELS, UNIT_FROM_KEY, KNOWN_CONVERSIONS, DEPRECATED_UNITS, UNIT_ALIASES, INTERMEDIATE_CONVERSIONS, KNOWN_UNITS, QUANTITIES_DESCRIPTION, UNITS_DESCRIPTION };
+interface AltUnitWithLabel {
+    unit: string | never;
+    label: string | undefined;
+}
+interface ValidateReturn {
+    valid: boolean;
+    errors: (string | undefined)[] | undefined;
+}
+
+declare function showAltUnitsList(quantityKey: string): string[] | undefined;
+declare function getUnitsForQuantity(quantity: string): string[] | undefined;
+declare function getQuantities(): string[] | undefined;
+declare function label(unitKey: string): string | undefined;
+declare function unitFromKey(quantity: string): string | undefined;
+declare function unitFromQuantity(quantity: string): string | undefined;
+declare function getAltUnitsListByQuantity(quantity: string): AltUnitWithLabel[] | undefined;
+declare function checkAndCleanDecimalComma(val: string | number): string | number;
+declare function to(value: string | number, fromUnit: string, toUnit: string): number;
+declare function split(numWithUnit: string): string[];
+declare function getValue(numWithUnit: string): string;
+declare function getUnit(numWithUnit: string): string;
+declare function unum(numWithUnit: string | number, toUnit: string, fromUnit?: string): number;
+declare function isValueWithUnit(value: string | number): boolean;
+declare function convertAndGetValue(numWithUnit: string | number, toUnit: string, fromUnit?: string): number;
+declare function convertAndGetValueStrict(value: string | number | null, toUnit: string, fromUnit?: string): string | number | null;
+declare function toBase(value: string, quantity: string): number;
+declare function convertTable(toUnitRow: any, table: any, defaultUnitRow?: [], removeFinalUnitsRow?: boolean): string | number[][];
+declare function roundNumberWithLabel(value: string, n?: number): string;
+declare function withUnit(value: string | number | null | undefined, unit: string | null, defaultVal?: string): string;
+declare function unumWithUnit(numWithUnit: string | number, toUnit: string, fromUnit?: string): string;
+declare function convertSamePrecision(numWithUnit: string | number, toUnit: string, digits?: number): string;
+declare function altUnitsList(value: string, quantity: string): (string | undefined)[][];
+declare function validateAndClean(previousValue: string, nextText: string): string;
+declare function withPrettyUnitLabel(valueWithUnits: string): string;
+declare function validateNumber(value: string | number): ValidateReturn;
+
+declare const LABELS: Record<string, string>;
+declare const ALT_UNITS: Record<string, string[]>;
+declare const UNIT_FROM_KEY: Record<string, string>;
+declare const KNOWN_CONVERSIONS: Record<string, (val: number) => number>;
+declare const DEPRECATED_UNITS: Record<string, string>;
+declare const UNIT_ALIASES: Record<string, string>;
+declare const INTERMEDIATE_CONVERSIONS: Record<string, string>;
+declare const KNOWN_UNITS: readonly string[];
+declare const QUANTITIES_DESCRIPTION: {
+    density: string;
+    length: string;
+    duration: string;
+    temperature: string;
+    tempgrad: string;
+    volume: string;
+    weight: string;
+    angles: string;
+    depth: string;
+    distance: string;
+    height: string;
+    diameters: string;
+    doglegSeverity: string;
+    fluidCompressibility: string;
+    force: string;
+    gasVolume: string;
+    oilVolume: string;
+    moleWeight: string;
+    linearCapacity: string;
+    stress: string;
+    thermalConductivity: string;
+    specificHeatCapacity: string;
+    thermalExpansionCoefficient: string;
+    youngsModulus: string;
+    torque: string;
+    areaOther: string;
+    areaTubular: string;
+    pumpRate: string;
+    pressure: string;
+    blowoutFlowRate: string;
+    percentage: string;
+    frequency: string;
+    torqueGradient: string;
+    pressureGradient: string;
+    flowrate: string;
+    massFlowRate: string;
+    angleGradient: string;
+    weightGradient: string;
+    forceGradient: string;
+    interfacialTension: string;
+    acceleration: string;
+    viscosity: string;
+    power: string;
+    intensity: string;
+    gasliftFlowRate: string;
+    productionFlowRate: string;
+    productionFlowRateOil: string;
+    productionFlowRateGas: string;
+    injectionFlowRate: string;
+    blowoutOilFlowRate: string;
+    blowoutGasFlowRate: string;
+    gor: string;
+    rotationalSpeed: string;
+    densityGas: string;
+    inflowProductivityIndex: string;
+    latitude: string;
+    longitude: string;
+    permeability: string;
+    sdstats: string;
+    roughness: string;
+    wltubulars: string;
+    speed: string;
+    inverseStandSpeed: string;
+    rop: string;
+    densityOil: string;
+    densityOilGas: string;
+    kickToleranceVolume: string;
+    densitySolid: string;
+    massPerLength: string;
+    durationShort: string;
+    durationLong: string;
+    wearFactor: string;
+    turbulentSkin: string;
+    pressurePerTemperature: string;
+    location: string;
+    mixingRequirements: string;
+    Entalphy: string;
+    shearStress: string;
+    volumeGradient: string;
+    deg: string;
+    dls: string;
+    wgrad: string;
+    entalphy: string;
+    pressurechange: string;
+    rpm: string;
+};
+declare const UNITS_DESCRIPTION: {
+    in: string;
+    mm: string;
+    cm: string;
+    m: string;
+    km: string;
+    ft: string;
+    usft: string;
+    in2: string;
+    cm2: string;
+    m2: string;
+    kg: string;
+    tonnes: string;
+    mt: string;
+    kip: string;
+    bbl: string;
+    Mm3: string;
+    MMSCF: string;
+    lbm: string;
+    'kg/mol': string;
+    'lbf/mol': string;
+    sg: string;
+    ppg: string;
+    'kg/m3': string;
+    'lbm/ft3': string;
+    s: string;
+    min: string;
+    h: string;
+    d: string;
+    month: string;
+    year: string;
+    'bbl/ft': string;
+    lpm: string;
+    bpm: string;
+    'm3/min': string;
+    'm3/s': string;
+    MMSCFD: string;
+    '1/MMSCFD': string;
+    bar: string;
+    Pa: string;
+    kPa: string;
+    MPa: string;
+    kPsi: string;
+    'kPa/m': string;
+    'psi/ft': string;
+    'bar/100m': string;
+    'psi/100ft': string;
+    'kPa/100m': string;
+    C: string;
+    F: string;
+    K: string;
+    'C/100m': string;
+    'F/100ft': string;
+    'K/100m': string;
+    'lbf/ft': string;
+    'Pa/C': string;
+    'Bar/C': string;
+    'psi/F': string;
+    'psi/C': string;
+    N: string;
+    kN: string;
+    'N/m': string;
+    'daN/m': string;
+    lbf: string;
+    kgf: string;
+    rad: string;
+    'BTU/lbm': string;
+    ppf: string;
+    'kg/m': string;
+    'E-06/degC': string;
+    'E-06/degF': string;
+    km2: string;
+    ft2: string;
+    mm2: string;
+    mile2: string;
+    ft3: string;
+    'g/cm3': string;
+    Sm3: string;
+    'ft3/s': string;
+    'ft3/d': string;
+    'm3/d': string;
+    '1/m3/d': string;
+    's/m3': string;
+    'bbl/d': string;
+    tonneForce: string;
+    USGal: string;
+    'g/mol': string;
+    Nm: string;
+    kNm: string;
+    ftlbf: string;
+    'J/(kg*degC)': string;
+    'J/(kg*degK)': string;
+    'BTU/(lbm*degF)': string;
+    'BTU/(h*ft*degF)': string;
+    l: string;
+    'l/m': string;
+    'kJ/kg': string;
+    'J/kg': string;
+    deg: string;
+    'W/(mK)': string;
+    psi: string;
+    '1/bar': string;
+    '1/psi': string;
+    'deg/100ft': string;
+    'deg/10m': string;
+    'deg/30m': string;
+    '%': string;
+    Hz: string;
+    '1/s': string;
+    rpm: string;
+    'Pa/m': string;
+    'bar/m': string;
+    gpm: string;
+    'kg/s': string;
+    'lbm/s': string;
+    'deg/m': string;
+    'deg/ft': string;
+    'rad/m': string;
+    'rad/ft': string;
+    'dyn/cm': string;
+    'mN/m': string;
+    '1/kPa': string;
+    m3: string;
+    'm/s': string;
+    'ft/s': string;
+    'm/min': string;
+    'ft/min': string;
+    'm/h': string;
+    'ft/h': string;
+    mph: string;
+    'km/h': string;
+    'm/s2': string;
+    'ft/s2': string;
+    'Pa*s': string;
+    P: string;
+    'mPa*s': string;
+    cP: string;
+    W: string;
+    hhp: string;
+    hp: string;
+    kW: string;
+    MW: string;
+    'BTU/h': string;
+    'hhp/in2': string;
+    'hhp/ft2': string;
+    'Mm3/d': string;
+    'STB/d': string;
+    'Sm3/d': string;
+    'MSm3/d': string;
+    'SCF/STB': string;
+    'Sm3/Sm3': string;
+    'SCF/d': string;
+    STB: string;
+    SCF: string;
+    Gsg: string;
+    Gppg: string;
+    'Gkg/m3': string;
+    'Glbm/ft3': string;
+    MSm3: string;
+    'm3/s/bar': string;
+    'Sm3/d/bar': string;
+    'STB/d/psi': string;
+    klbf: string;
+    '1/Pa': string;
+    '1/MPa': string;
+    ksi: string;
+    'lbf/100ft2': string;
+    'lb/ft3': string;
+    '\u00B0N': string;
+    '\u00B0S': string;
+    '\u00B0W': string;
+    '\u00B0E': string;
+    fr: string;
+    mD: string;
+    Sigma: string;
+    CI: string;
+    'J/(s*m*degK)': string;
+    'C/m': string;
+    'F/ft': string;
+    'K/m': string;
+    microM: string;
+    'W/m2': string;
+    '1/K': string;
+    'lb/ft': string;
+    'E-09/bar': string;
+    'E-10/psi': string;
+    'E-14/pa': string;
+    lk: string;
+    ftCla: string;
+    lkCla: string;
+    ftSe: string;
+    ydSe: string;
+    chSe: string;
+    'chSe(T)': string;
+    ftGC: string;
+    ydInd: string;
+    'd/stand': string;
+    'h/stand': string;
+    'min/stand': string;
+    's/stand': string;
+    'm3/t': string;
+    'L/100kg': string;
+    GPa: string;
+    'cm3/m': string;
+    'in3/ft': string;
+    'ft3/ft': string;
+    'm3/m': string;
+    'mm3/m': string;
+    '1/GPa': string;
+    lps: string;
+};
+
+declare function isEmptyValueWithUnit(val: string | number): boolean;
+declare const isFraction: (value: unknown) => boolean;
+declare function isNumeric(v: unknown): boolean;
+declare function allNumbers(arr: (number | string)[]): boolean;
+declare const formatNumber: (number: number | string | undefined | null) => string;
+declare function charCount(chr: string | number, str: string): number;
+declare function getNumberOfDigitsToShow(num: number | string, maxNumDigits?: number): number;
+declare function fraction(str: any): number | typeof Infinity | typeof NaN;
+declare function asFraction(str: number | string): string;
+declare function numFraction(str: any): any;
+declare function cleanNumStr(str: string | number): string;
+declare const stripLeadingZeros: (value: string) => string;
+declare function cleanNum(str: string | number): number;
+declare const isNonNumerical: (value: any) => boolean;
+
+declare const isValidNum: (value: unknown) => boolean;
+declare const isScientificStringNum: (value: unknown) => boolean;
+declare const toNum: (value: unknown, fallback?: number, minimum?: number) => any;
+declare const toString: (value?: unknown) => unknown;
+
+type NumberDisplayOptions = {
+    scientific?: 'auto' | boolean;
+    eNotation?: boolean;
+    autoScientificBelow?: number;
+    autoScientificAbove?: number;
+    roundScientificCoefficient?: number;
+    withUnit?: boolean;
+    noThousandsSeparator?: boolean;
+    nonBreakingSpace?: boolean;
+};
+declare const displayNumber: <Value extends number | string | null | undefined>(value: Value, options?: NumberDisplayOptions) => string;
+declare const displayNumberToFixed: <Value extends string | null | undefined>(value: Value, options?: NumberDisplayOptions) => string;
+
+declare const round: <Value extends number | string | null | undefined>(value: Value, n?: number) => Value;
+declare const roundToPrecision: <Value extends number | string | null | undefined>(value: Value, n?: number) => Value;
+declare const roundToDecimalPrecision: <Value extends number | string | null | undefined>(value: Value, n?: number) => Value;
+declare const roundByMagnitude: <Value extends number | string | null | undefined>(value: Value, n?: number) => Value;
+declare const roundByMagnitudeToFixed: <Value extends number | string | null | undefined>(value: Value, n?: number) => Value;
+declare const roundByRange: <Value extends number | string | null | undefined>(value: Value, min: number, max: number, n?: number) => Value;
+declare const roundToFixed: <Value extends number | string | null | undefined>(value: Value, n?: number) => Value;
+
+type Without<T, U> = {
+    [P in Exclude<keyof T, keyof U>]?: never;
+};
+type XOR<T, U> = (T | U) extends Record<string, unknown> ? (Without<T, U> & U) | (Without<U, T> & T) : T | U;
+type toleranceType = XOR<{
+    relativeDiff: number | string;
+}, {
+    absoluteDiff: string | number;
+}>;
+declare const isCloseTo: (firstValue: number | string | null, secondValue: number | string | null, options?: toleranceType) => boolean;
+declare const isCloseToOrGreaterThan: (firstValue: number | string | null, secondValue: number | string | null, options?: toleranceType) => boolean;
+declare const isCloseToOrLessThan: (firstValue: number | string | null, secondValue: number | string | null, options?: toleranceType) => boolean;
+declare const isDeepCloseTo: (a: any, b: any, options?: toleranceType) => boolean;
+
+export { ALT_UNITS, DEPRECATED_UNITS, INTERMEDIATE_CONVERSIONS, KNOWN_CONVERSIONS, KNOWN_UNITS, LABELS, QUANTITIES_DESCRIPTION, UNITS_DESCRIPTION, UNIT_ALIASES, UNIT_FROM_KEY, allNumbers, altUnitsList, asFraction, charCount, checkAndCleanDecimalComma, cleanNum, cleanNumStr, convertAndGetValue, convertAndGetValueStrict, convertSamePrecision, convertTable, displayNumber, displayNumberToFixed, formatNumber, fraction, getAltUnitsListByQuantity, getNumberOfDigitsToShow, getQuantities, getUnit, getUnitsForQuantity, getValue, isCloseTo, isCloseToOrGreaterThan, isCloseToOrLessThan, isDeepCloseTo, isEmptyValueWithUnit, isFraction, isNonNumerical, isNumeric, isScientificStringNum, isValidNum, isValueWithUnit, label, numFraction, round, roundByMagnitude, roundByMagnitudeToFixed, roundByRange, roundNumberWithLabel, roundToDecimalPrecision, roundToFixed, roundToPrecision, showAltUnitsList, split, stripLeadingZeros, to, toBase, toNum, toString, unitFromKey, unitFromQuantity, unum, unumWithUnit, validateAndClean, validateNumber, withPrettyUnitLabel, withUnit };