Interfaces

SmartUnitOptions

Configuration options interface.

interface SmartUnitOptions {
  baseDigit?: number              // Auto-generate ratios
  threshold?: number              // Threshold for unit switching (default: 1)
  fractionDigits?: FractionDigits // Number of decimal places
  separator: string,              // Separator, only used in `formatChain` method
  decimalOptions?: object         // Decimal.js configuration (only valid in high-precision mode)
}

FormattedValue

Formatted result interface.

interface FormattedValue<U extends string> {
  num: number           // Numeric value
  unit: U               // Unit
  numStr: string        // Formatted number string
  decimal?: Decimal     // Decimal instance (only in high-precision mode)
}

FractionDigits

Decimal places configuration type.

type FractionDigits =
  | number                // Fixed decimal places
  | `-${number}`          // Only set maximum value
  | `${number}-`          // Only set minimum value
  | `${number}-${number}` // Set range

NumPrecision

Represents the supported input types in high-precision mode.

type NumPrecision = Num | string | bigint | Decimal

Utility Types

GetUnitNames

Pass a SmartUnit instance to return the union type of unit names.

type GetUnitNames<SU extends SmartUnitBase<any>>