Categorygithub.com/jackc/numfmt
modulepackage
0.0.0-20210209201056-0429016d44dd
Repository: https://github.com/jackc/numfmt.git
Documentation: pkg.go.dev

# README

Go Reference CI

numfmt

numfmt is a number formatting package for Go.

Features

  • Rounding to N decimal places
  • Always display minimum of N decimal places
  • Configurable thousands separators
  • Scaling for percentage formatting
  • Format negative values differently for correct currency output like -$12.34 or (12.34)
  • Easy to use with text/template and html/template

Examples

Use directly from Go:

f := &numfmt.Formatter{
  NegativeTemplate: "(n)",
  MinDecimalPlaces: 2,
}
f.Format("-1234") // => "(1,234.00)"

Or in use in text/template:

{{numfmt "1234.5"}} => "1,234.5"
{{numfmt "GroupSeparator" " " "DecimalSeparator" "," "1234.5"}} => "1 234,5"

See the documentation for more examples.

# Functions

NewPercentFormatter returns a formatter that formats a number such as 0.75 to 75%.
NewUSDFormatter returns a Formatter for US dollars.
TemplateFunc is a helper method for use with text/template and html/template.

# Structs

Formatter is a formatter of numbers.
No description provided by the author