react-native-android-currency-formatter/README.md

React Native Android Currency Formatter. Native Module for a currency format with specified FORMAT locale.

# React Native Android Currency Formatter [![Twitter URL](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?hashtags=reactnative%2Cjavascript&original_referer=https%3A%2F%2Fpublish.twitter.com%2F&ref_src=twsrc%5Etfw%7Ctwcamp%5Ebuttonembed%7Ctwterm%5Eshare%7Ctwgr%5E&text=React%20Native%20Android%20Currency%20Formatter.%20Native%20Module%20for%20a%20currency%20format%20with%20specified%20FORMAT%20locale.&url=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2Freact-native-android-currency-formatter&via=shystrukk) #
[![MIT Licence](https://badges.frapsoft.com/os/mit/mit.svg?v=103)](https://opensource.org/licenses/mit-license.php)
[![npm version](https://badge.fury.io/js/react-native-android-currency-formatter.svg)](https://badge.fury.io/js/react-native-android-currency-formatter)

Native Module for a currency format with specified FORMAT locale.

## Installation

#### npm
```sh
npm install --save react-native-android-currency-formatter
```

#### yarn
```sh
yarn add react-native-android-currency-formatter --save
```

### For iOS use [Internationalization API](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat)

## Usage

**Read before use [Synchronous Method](https://reactnative.dev/docs/native-modules-android#synchronous-methods)**

```js
import AndroidCurrencyFormatter from 'react-native-android-currency-formatter';

// Synchronous Method
AndroidCurrencyFormatter.numberFormat(30000, 'USD', 'en', 'US'); // $30,000.00

// Asynchronous Method
AndroidCurrencyFormatter
	.numberFormatAsync(1000000.25, 'USD', 'en', 'US')
	.then(data => {
		// $1,000,000.25
	});
```

## API ##
```js
// Synchronous Method
// Returns currency format or 'N/A' if one of the arguments are not correct
numberFormat(amount, currencyCode, language, country)

// Asynchronous Method
// Returns Promise with currency format or 'N/A' if one of the arguments are not correct
numberFormatAsync(amount, currencyCode, language, country)

```
### amount
Type: `Number` <br>
the number which will be converted to currency

### currencyCode
Type: `String` <br>
ISO 4217 currency code. [Some codes](https://stackoverflow.com/questions/3536968/get-all-possible-available-currencies/39259097#39259097)

### language
Type: `String` <br>
An ISO 639 alpha-2 or alpha-3 language code, or a language subtag up to 8 characters in length.

### country
Type: `String` <br>
An ISO 3166 alpha-2 country code or a UN M.49 numeric-3 area code.

Check [example/src/App.tsx](example/src/App.tsx) file if you need more details.

![](example/assets/demo.png)

## Contributing

Any contributions you make **are greatly appreciated**.

Please read the [Contributions Guidelines](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.


## License

MIT © [Vasyl Stokolosa](https://about.me/shystruk)