money

Documentation

Overview

Package money represents money values with no loss in precision and without rounding errors.

Index

• Variables
• type FormatConfig
  • func Currency(currency string) FormatConfig
• type Money
  • func FromCents(cents int32) Money
  • func Parse(s string) (Money, error)
  • func (m Money) Add(other Money) Money
  • func (m Money) AddTaxPercent(tax int32) Money
  • func (m Money) Cents() int32
  • func (m Money) Div(other Money) Money
  • func (m Money) Format(config FormatConfig) string
  • func (m Money) IsZero() bool
  • func (m Money) LessThan(other Money) bool
  • func (m Money) Mul(n int32) Money
  • func (m Money) String() string
  • func (m Money) Sub(other Money) Money

Variables

var (
	EUR = FormatConfig{
		Symbol:   "\u20ac",
		Thousand: ",",
	}

	USD = FormatConfig{
		Symbol:   "$",
		Prefix:   true,
		Thousand: ",",
	}

	GBP = FormatConfig{
		Symbol:   "\u00a3",
		Prefix:   true,
		Thousand: ",",
	}

	MXN = FormatConfig{
		Symbol:   "Mex$",
		Prefix:   true,
		Thousand: ",",
	}
)

Types

type FormatConfig

type FormatConfig struct {
	Symbol        string
	Prefix        bool
	Thousand      string
	Decimal       string
	ForceDecimals bool
}

func Currency

func Currency(currency string) FormatConfig

Currency returns the configuration of a currency by its name. Unknown currencies will return the default config.

type Money

type Money int32

func FromCents

func FromCents(cents int32) Money

FromCents creates a new instance with a cents value.

func Parse

func Parse(s string) (Money, error)

Parse a string to create a new money value. It can read `XX.YY` and `XX,YY`. An empty string is parsed as zero.

func (Money) Add

func (m Money) Add(other Money) Money

Add two money values together and returns the result.

func (Money) AddTaxPercent

func (m Money) AddTaxPercent(tax int32) Money

AddTaxPercent adds a percentage of the price to itself.

func (Money) Cents

func (m Money) Cents() int32

Cents returns the value with cents precision (2 decimal places) as a number.

func (Money) Div

func (m Money) Div(other Money) Money

Div divides two money values and returns the result.

func (Money) Format

func (m Money) Format(config FormatConfig) string

Format the money value with a specific configuration.

func (Money) IsZero

func (m Money) IsZero() bool

IsZero returns true if there is no money.

func (Money) LessThan

func (m Money) LessThan(other Money) bool

LessThan returns true if a money value is less than the other.

func (Money) Mul

func (m Money) Mul(n int32) Money

Mul multiplies the money value n times and returns the result.

func (Money) String

func (m Money) String() string

Format the money value with the default configuration

func (Money) Sub

func (m Money) Sub(other Money) Money

Sub subtracts two money values and returns the result.