money

README

github.com/crediterra/money

Golang package to work with money

Documentation

Index

• Constants
• Variables
• func HasCurrencyPrefix(s string) bool
• func IsKnownCurrency(c CurrencyCode) bool
• type Amount
  • func NewAmount(currency CurrencyCode, value decimal.Decimal64p2) Amount
  • func (a Amount) IsZero() bool
  • func (a Amount) String() string
  • func (a Amount) Validate() error
• type Balance
  • func (b Balance) Add(amount Amount) Balance
  • func (b Balance) CommaSeparatedUnsignedWithSymbols(translator interface{ ... }) string
  • func (b Balance) Equal(b2 Balance) bool
  • func (b Balance) IsZero() bool
  • func (b Balance) OnlyNegative() Balance
  • func (b Balance) OnlyPositive() Balance
  • func (b Balance) Reversed() (reversed Balance)
• type Balanced
  • func (v *Balanced) AddToBalance(currency CurrencyCode, value decimal.Decimal64p2)
• type CurrencyCode
  • func CleanupCurrency(s string) CurrencyCode
  • func (c CurrencyCode) IsMoney() bool
  • func (c CurrencyCode) Sign() string
  • func (c CurrencyCode) SignAndCode() string
• type TestStruct

Constants

const (
	CurrencySymbolEUR = "€"
	CurrencySymbolUSD = "$"
	CurrencySymbolGPB = "£"
	CurrencySymbolJPY = "¥"
	CurrencySymbolRUR = "₽"
	CurrencySymbolIRR = "﷼"
	CurrencySymbolUAH = "₴"
	CurrencySymbolUZS = "сўм"
	CurrencySymbolBYN = "Br"
	CurrencySymbolTJS = "смн."
	CurrencySymbolKZT = "₸"
)

Variables

var CurrencyBYN = CurrencyCode("BYN")

var CurrencyEUR = CurrencyCode("EUR")

var CurrencyGBP = CurrencyCode("GPB")

var CurrencyIRR = CurrencyCode("IRR")

var CurrencyJPY = CurrencyCode("JPY")

var CurrencyKZT = CurrencyCode("KZT")

var CurrencyRUB = CurrencyCode("RUB")

var CurrencyTJS = CurrencyCode("TJS")

var CurrencyUAH = CurrencyCode("UAH")

var CurrencyUSD = CurrencyCode("USD")

var CurrencyUZS = CurrencyCode("UZS")

Functions

func HasCurrencyPrefix

func HasCurrencyPrefix(s string) bool

func IsKnownCurrency

func IsKnownCurrency(c CurrencyCode) bool

Types

type Amount

type Amount struct {
	Currency CurrencyCode        `json:"currency" firestore:"currency"`
	Value    decimal.Decimal64p2 `json:"value" firestore:"value"`
}

Amount holds amount of money with currency

func NewAmount

func NewAmount(currency CurrencyCode, value decimal.Decimal64p2) Amount

NewAmount creates new amount

func (Amount) IsZero

func (a Amount) IsZero() bool

IsZero returns true if amount is zero

func (Amount) String

func (a Amount) String() string

String returns string representation of amount

func (Amount) Validate

func (a Amount) Validate() error

Validate returns error if amount is invalid

type Balance

type Balance map[CurrencyCode]decimal.Decimal64p2

func (Balance) Add

func (b Balance) Add(amount Amount) Balance

func (Balance) CommaSeparatedUnsignedWithSymbols

func (b Balance) CommaSeparatedUnsignedWithSymbols(translator interface{ Translate(s string) string }) string

func (Balance) Equal

func (b Balance) Equal(b2 Balance) bool

func (Balance) IsZero

func (b Balance) IsZero() bool

func (Balance) OnlyNegative

func (b Balance) OnlyNegative() Balance

func (Balance) OnlyPositive

func (b Balance) OnlyPositive() Balance

func (Balance) Reversed

func (b Balance) Reversed() (reversed Balance)

type Balanced

type Balanced struct {
	Balance        Balance   `firestore:"balance,noindex,omitempty,noindex" json:"balance,omitempty"`
	LastTransferID string    `datastore:"lastTransferID,omitempty,noindex" json:"lastTransferID,omitempty"`
	LastTransferAt time.Time `datastore:"lastTransferAt,omitempty,noindex" json:"lastTransferAt,omitempty"`

	// Do not remove, needed to hide a balance/history menu in Telegram
	CountOfTransfers int `datastore:"countOfTransfers,omitempty" json:"countOfTransfers,omitempty"`
}

Balanced is a struct to store balance and summary of transfers ffjson: skip

func (*Balanced) AddToBalance

func (v *Balanced) AddToBalance(currency CurrencyCode, value decimal.Decimal64p2)

type CurrencyCode

type CurrencyCode string

func CleanupCurrency

func CleanupCurrency(s string) CurrencyCode

func (CurrencyCode) IsMoney

func (c CurrencyCode) IsMoney() bool

func (CurrencyCode) Sign

func (c CurrencyCode) Sign() string

func (CurrencyCode) SignAndCode

func (c CurrencyCode) SignAndCode() string

type TestStruct

type TestStruct struct {
	ID   int64
	Name string
}