class Money::Currency

• Money::Currency
• Reference
• Object

Overview

Represents a specific currency unit.

See ISO 4217.

Included Modules

• Comparable(Money::Currency)
• JSON::Serializable

Extended Modules

• Money::Currency::Enumeration
• Money::Currency::Loader

Defined in:

Constructors

• .new(pull : JSON::PullParser)
• .new(*, type : Money::Currency::Type | Nil = nil, priority : Int32 | Nil = nil, iso_numeric : Int32 | Nil = nil, code : String, name : Nil | String = nil, symbol : Nil | String = nil, disambiguate_symbol : Nil | String = nil, alternate_symbols : Nil | Array(String) = nil, subunit : Nil | String = nil, subunit_to_unit : UInt64, symbol_first : Bool | Nil = nil, decimal_mark : Nil | String = nil, thousands_separator : Nil | String = nil, smallest_denomination : Int32 | Nil = nil)
• .register(currency : Currency) : Currency

  Registers a new currency.

Class Method Summary

• .crypto : Array(Currency)

  Returns an array of currencies of type Crypto.

• .fiat : Array(Currency)

  Returns an array of currencies of type Fiat.

• .metal : Array(Currency)

  Returns an array of currencies of type Metal.

• .registry : Hash(String, Currency)

  List of known currencies.

• .reset! : Nil

  Resets all registered currencies to their defaults.

• .unregister(currency : String | Symbol | Currency) : Currency | Nil

  Unregisters a currency.

Instance Method Summary

• #<=>(other : Currency) : Int32

  Compares self with other currency against the value of #priority and #id attributes.

• #==(other : self)

  Returns true if this reference is the same as other.

• #alternate_symbols : Array(String) | Nil

  Alternate symbols.

• #cents_based? : Bool

  Returns true if a subunit is cents-based.

• #code : String

  Currency code.

• #crypto? : Bool

  Returns true if the currency #type is Crypto, otherwise false.

• #decimal_mark : String | Nil

  Decimal mark.

• #decimal_places : Int32

  Alias of #exponent.

• #disambiguate_symbol : String | Nil

  Disambiguation symbol.

• #exponent : Int32

  Returns the relation between subunit and unit as a base 10 exponent.

• #fiat? : Bool

  Returns true if the currency #type is Fiat, otherwise false.

• #hash(hasher)

  See Object#hash(hasher)

• #id : String

  Currency ID (lower-cased #code).

• #iso? : Bool

  Returns true if iso currency.

• #iso_numeric : Int32 | Nil

  ISO 4217 numeric code.

• #metal? : Bool

  Returns true if the currency #type is Metal, otherwise false.

• #name : String | Nil

  Currency name.

• #priority : Int32 | Nil

  Currency priority (used for sorting).

• #smallest_denomination : Int32 | Nil

  Smallest denomination.

• #subunit : String | Nil

  Currency subunit.

• #subunit_to_unit : UInt64

  Subunit to unit value.

• #symbol : String | Nil

  Currency symbol.

• #symbol_first? : Bool | Nil

  Should the symbol be placed before the amount?

• #thousands_separator : String | Nil

  Thousands separator.

• #to_s(io : IO) : Nil

  Appends a string representation corresponding to the #code property to the given io.

• #type : Type | Nil

  Currency type.

Constructor Detail

Class Method Detail

Instance Method Detail

Money::Currency.find(:usd).cents_based? # => true
Money::Currency.find(:btc).cents_based? # => false

Money::Currency.find(:usd).exponent # => 2
Money::Currency.find(:btc).exponent # => 8

Money::Currency.find(:usd).iso? # => true
Money::Currency.find(:btc).iso? # => false

Money::Currency.find(:usd).to_s # => "USD"
Money::Currency.find(:btc).to_s # => "BTC"