Skip to content

Money Formatters is designed to simplify the formatting of monetary values according to various currencies. Whether you're dealing with international transactions, financial applications, or simply need consistent and readable representations of currency values, this package offers a convenient solution.

Notifications You must be signed in to change notification settings

Erij-Maherzia-BEN-BRAHIM/money-formatters

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Money Formatters

Money Formatters is a lightweight library for formatting monetary values according to various currencies in JavaScript/TypeScript.

Installation

To install Money Formatters, you can use npm:

npm install money-formatters

or yarn

yarn add money-formatters

Usage

asAmount

The asAmount function formats the given amount in the base unit to its corresponding value for the specified currency token.

For example, converting 100 cents to USD would result in 1,00 $.

const formattedAmount = asAmount({
  amount: 100000,
  token: "USD"
});

console.log(formattedAmount); // Output: 1 000,00 $

Options

Option Description Example Usage Output
symbolToTheLeft Determines whether the currency symbol should be placed to the left of the formatted amount (default: false). symbolToTheLeft: true $1 000,00
locale The locale used for formatting the amount (default: "fr-FR"). locale: "fr-FR" or locale: "en-US" 1 000,00 $ or 1,000.00 $
showCurrencyCode Determines whether the currency code should be displayed alongside the formatted amount (default: false). showCurrencyCode: true 1 000,00 USD
negativeFormat Determines how negative numbers should be formatted. Possible values: "minus" or "parentheses". Default: "minus". negativeFormat: "parentheses" or negativeFormat: "minus" (1 000,00 $) or -1 000,00 $

asAmountWithoutDecimals

The asAmountWithoutDecimals function calculates the equivalent amount in the base unit (e.g., dollars to cents) based on the specified currency token.

For example, 1 Dollar (USD) is equivalent to 100 cents. Therefore, calling asAmountWithoutDecimals(1, "USD") would return 100, representing 100 cents.

import { asAmountWithoutDecimals } from "money-formatters";

const amountWithoutDecimals = asAmountWithoutDecimals(1000, "USD");

console.log(amountWithoutDecimals); // Output: 100000

About

Money Formatters is designed to simplify the formatting of monetary values according to various currencies. Whether you're dealing with international transactions, financial applications, or simply need consistent and readable representations of currency values, this package offers a convenient solution.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published