@oliasoft-open-source/units 4.7.0 → 5.0.0-beta-1

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-export { altUnitsList, checkAndCleanDecimalComma, convertAndGetValue, convertAndGetValueStrict, convertSamePrecision, convertTable, getAltUnitsListByQuantity, getQuantities, getUnit, getUnitsForQuantity, getValue, isValueWithUnit, label, roundNumberWithLabel, showAltUnitsList, split, to, toBase, unitFromKey, unitFromQuantity, unum, unumWithUnit, validateAndClean, validateNumber, withPrettyUnitLabel, withUnit } from './units.js';
-export { isScientificStringNum, isValidNum, toNum, toString } from './numbers/numbers.js';
-import './interfaces.js';
+import { altUnitsList, checkAndCleanDecimalComma, convertAndGetValue, convertAndGetValueStrict, convertSamePrecision, convertTable, getAltUnitsListByQuantity, getQuantities, getUnit, getUnitsForQuantity, getValue, isValueWithUnit, label, roundNumberWithLabel, showAltUnitsList, split, to, toBase, unitFromKey, unitFromQuantity, unum, unumWithUnit, validateAndClean, validateNumber, withPrettyUnitLabel, withUnit } from "./units.js";
+import { isScientificStringNum, isValidNum, toNum, toString } from "./numbers/numbers.js";
 
+//#region src/constants.d.ts
 declare const LABELS: Record<string, string>;
 declare const ALT_UNITS: Record<string, string[]>;
 declare const UNIT_FROM_KEY: Record<string, string>;
@@ -11,312 +11,313 @@ 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;
-    sensorAccelerometer: string;
-    sensorMagnetometer: string;
+  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;
+  sensorAccelerometer: string;
+  sensorMagnetometer: 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;
-    'tonnes/h': string;
-    'tons/h': 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;
-    'Sm3/min': 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;
-    nT: string;
-    Gs: string;
-    g: string;
+  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;
+  'tonnes/h': string;
+  'tons/h': 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;
+  'Sm3/min': 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;
+  nT: string;
+  Gs: string;
+  g: string;
 };
-
+//#endregion
+//#region src/utils.d.ts
 declare function isEmptyValueWithUnit(val: string | number): boolean;
 declare const isFraction: (value: unknown) => boolean;
 declare function isNumeric(v: unknown): boolean;
@@ -331,20 +332,22 @@ 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;
-
+//#endregion
+//#region src/numbers/display-number.d.ts
 type NumberDisplayOptions = {
-    scientific?: 'auto' | boolean;
-    eNotation?: boolean;
-    autoScientificBelow?: number;
-    autoScientificAbove?: number;
-    roundScientificCoefficient?: number;
-    withUnit?: boolean;
-    noThousandsSeparator?: boolean;
-    nonBreakingSpace?: boolean;
+  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;
-
+//#endregion
+//#region src/rounding/rounding.d.ts
 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;
@@ -352,20 +355,19 @@ declare const roundByMagnitude: <Value extends number | string | null | undefine
 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;
-};
+//#endregion
+//#region src/comparison/comparison.d.ts
+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;
+  relativeDiff: number | string;
 }, {
-    absoluteDiff: string | number;
+  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, asFraction, charCount, cleanNum, cleanNumStr, displayNumber, displayNumberToFixed, formatNumber, fraction, getNumberOfDigitsToShow, isCloseTo, isCloseToOrGreaterThan, isCloseToOrLessThan, isDeepCloseTo, isEmptyValueWithUnit, isFraction, isNonNumerical, isNumeric, numFraction, round, roundByMagnitude, roundByMagnitudeToFixed, roundByRange, roundToDecimalPrecision, roundToFixed, roundToPrecision, stripLeadingZeros };
-//# sourceMappingURL=index.d.ts.map
+//#endregion
+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 };
+//# sourceMappingURL=index.d.ts.map