sealed_currencies 0.0.1

sealed_currencies: ^0.0.1 copied to clipboard

This ISO-driven, pure Dart, and dependency-free package provides information about world currencies in form of compile-time constant sealed classes. Contains the all actively used 169¹ currencies with ISO letter 4217 codes, also provides ISO 4217 numeric codes, their English, native names, units, subunits, etc.

Features #

FiatCurrency class provides the following information about currencies:

Compile time constant list of all currencies accessible via FiatCurrency.list and more over, the FiatCurrency class provides the following methods:

• maybeFromValue - returns a currency instance if the value matches the provided value, otherwise returns null.
• fromCode - returns a currency instance if the value matches the provided ISO 4217 letter code.
• fromCodeNumeric - returns a currency instance if the value matches the provided ISO 4217 numeric code.
• fromName - returns a currency instance if the value matches the provided English name.

and (thanks to sealed nature of the class) functional-style like methods: whenOrNull, maybeWhen, when, map, maybeMap.

Getting started #

To use this package, add sealed_currencies as a dependency in your pubspec.yaml file.

dependencies:
  sealed_currencies: any

Then import the package in your Dart code:

import 'package:sealed_currencies/sealed_currencies.dart';

Usage #

Use FiatCurrency class to get information about currencies. Either construct a new instance directly or with use of the class factory constructors/method fromCode, fromCodeNumeric, fromName or from any value that class contains maybeFromValue, or select one from the FiatCurrency.list constant.

  print(FiatCurrency.list.length); // Prints: "169".

  final serbianDinar = FiatCurrency.fromCode("Rsd");
  print(serbianDinar); // Prints: "Serbian Dinar".

  final maybeEuro = FiatCurrency.maybeFromValue(
    "Euro",
    where: (currency) => currency.namesNative.first,
  );
  print(maybeEuro?.toString(short: false));
  /*
  Prints: "FiatCurrency(code: EUR, priority: 2, name: Euro, namesNative: [Euro],
   symbol: €, disambiguateSymbol: null, alternateSymbols: null, subunit: Cent,
  subunitToUnit: 100, unitFirst: true, htmlEntity: €, decimalMark: ",",
  thousandsSeparator: ".", codeNumeric: 978, smallestDenomination: 1)".
  */

For more usage examples, please see the /example folder.

Additional information #

For more information on using this package, check out the API documentation. If you have any issues or suggestions for the package, please file them in the GitHub repository.

References, credits and sources #

• ISO
• Wikipedia
• Data Source²