https://github.com/fluidsonic/fluid-currency

Kotlin multiplatform currency library (alpha)
https://github.com/fluidsonic/fluid-currency

currency currency-codes kotlin kotlin-multiplatform

Last synced: 15 days ago
JSON representation

Kotlin multiplatform currency library (alpha)

• Host: GitHub
• URL: https://github.com/fluidsonic/fluid-currency
• Owner: fluidsonic
• License: apache-2.0
• Created: 2020-08-22T16:14:05.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-06-24T03:30:13.000Z (over 1 year ago)
• Last Synced: 2024-11-10T13:36:58.265Z (about 1 month ago)
• Topics: currency, currency-codes, kotlin, kotlin-multiplatform
• Language: Kotlin
• Homepage:
• Size: 245 KB
• Stars: 19
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• kmp-awesome - fluid-currency - currency library (Libraries / 🔧 Utils)

README

        
fluid-currency

==============

[![Maven Central](https://img.shields.io/maven-central/v/io.fluidsonic.currency/fluid-currency?label=Maven%20Central)](https://search.maven.org/artifact/io.fluidsonic.currency/fluid-currency)

[![Tests](https://github.com/fluidsonic/fluid-currency/workflows/Tests/badge.svg)](https://github.com/fluidsonic/fluid-currency/actions?workflow=Tests)

[![Kotlin](https://img.shields.io/badge/Kotlin-1.8.22%20(Darwin,%20JVM,%20JS)-blue.svg)](https://github.com/JetBrains/kotlin/releases/v1.8.22)

[![#fluid-libraries Slack Channel](https://img.shields.io/badge/slack-%23fluid--libraries-543951.svg?label=Slack)](https://kotlinlang.slack.com/messages/C7UDFSVT2/)

Kotlin multiplatform currency library.

This is most useful in combination with [fluid-i18n](https://github.com/fluidsonic/fluid-i18n) for retrieving internationalized information about a currency.

Installation

------------

`build.gradle.kts`:

```kotlin

dependencies {

	implementation("io.fluidsonic.currency:fluid-currency:0.13.0")

}

```

Usage

-----

```kotlin

println(Currency.fromCode("EUR")) // EUR

```

### `class Currency`

A class with information about a specific currency defined by [ISO 4217](https://www.currency-iso.org/en/home/tables/table-a1.html).

```kotlin

val currency = Currency.forCode("EUR") // throws if code is invalid (not defined by ISO 4217) or has an invalid format (not three latin letters)

println(currency.code) // EUR

println(currency.defaultFractionDigits) // 2

println(currency.numericCode) // 978

```

```kotlin

val currency = Currency.forCodeOrNull("ABC123") // null if code is invalid (not defined by ISO 4217) or has an invalid format (not three latin letters)

println(currency) // null

```

### `class CurrencyCode`

An inline class for ISO 4217 3-letter currency codes (e.g. `EUR` or `USD`).

```kotlin

val code = CurrencyCode.parse("EUR") // throws if code has invalid format (not three latin letters)

println(code.toString()) // EUR

println(code.isValid()) // true - 'EUR' is defined by ISO 4217

```

```kotlin

val code = CurrencyCode.parse("abc") // throws if code has invalid format (not three latin letters)

println(code.toString()) // ABC

println(code.isValid()) // false - 'ABC' is not defined by ISO 4217

```

```kotlin

val code = CurrencyCode.parseOrNull("ABC123") // null if code has invalid format (not three latin letters)

println(code) // null

```

License

-------

Apache 2.0