formatAmount function

String formatAmount(
  1. Decimal? val, {
  2. int? precision,
  3. bool showSign = false,
  4. bool signFirst = false,
  5. RoundMode? roundMode,
  6. bool enableCompact = true,
  7. CompactConverter? compactConverter,
  8. bool cutInvalidZero = true,
  9. ShrinkZeroMode? shrinkZeroMode,
  10. ShrinkZeroConverter? shrinkZeroConverter,
  11. ExplicitDirection? direction,
  12. String prefix = '',
  13. String suffix = '',
  14. String? defIfZero,
  15. String defIfNull = '--',
})

Format amount value 格式化数量值

This is a convenience function that wraps formatNumber with amount-specific defaults:

  • Compact converter enabled by default (enableCompact = true)
  • Trailing zeros removed by default (cutInvalidZero = true)

这是一个便捷函数,使用数量特定的默认值包装 formatNumber

  • 默认启用精简转换器 (enableCompact = true)
  • 默认删除尾部零 (cutInvalidZero = true)

Implementation

String formatAmount(
  Decimal? val, {
  int? precision,
  bool showSign = false,
  bool signFirst = false,
  RoundMode? roundMode,
  bool enableCompact = true,
  CompactConverter? compactConverter,
  bool cutInvalidZero = true,
  ShrinkZeroMode? shrinkZeroMode,
  ShrinkZeroConverter? shrinkZeroConverter,
  ExplicitDirection? direction,
  String prefix = '',
  String suffix = '',
  String? defIfZero,
  String defIfNull = '--',
}) {
  return formatNumber(
    val,
    precision: precision,
    showSign: showSign,
    signFirst: signFirst,
    roundMode: roundMode,
    enableCompact: enableCompact,
    compactConverter: compactConverter,
    cutInvalidZero: cutInvalidZero,
    shrinkZeroMode: shrinkZeroMode,
    shrinkZeroConverter: shrinkZeroConverter,
    direction: direction,
    prefix: prefix,
    suffix: suffix,
    defIfZero: defIfZero,
    defIfNull: defIfNull,
  );
}