persian-toman

Format and convert Persian Rial and Toman prices using blazingly fast implementation which is flexible at the same time.

To install:

npm i persian-toman

Usage with ESM:

import { rialToToman, tomanToRial, rialToTomanNumber, tomanToRialNumber } from 'persian-toman'

Usage with CJS:

const { rialToToman, tomanToRial, rialToTomanNumber, tomanToRialNumber } = require("persian-toman")

Formatting and converting a Rial price to Toman:

const rial = 69_000
const toman = rialToToman(rial) // '۶٫۹۰۰ تومان'

Same for the opposite side:

const toman = 69_000
const rial = tomanToRial(toman) // '۶۹۰٫۰۰۰ ریال'

Convert just numbers using shorthand methods:

const price = 85_000
const toman = rialToTomanNumber(price) // 8500
const rial = tomanToRialNumber(price) // 850000

The rialToToman and tomanToRial functions have an optional second argument for modifying the ouput format.

You can opt out of delimiter:

const price = 85_000
const toman = rialToToman(price, { delimiter: false }) // '۸۵۰۰ تومان'

Also, you can opt out of Persian digit conversion:

const price = 85_000
const toman = rialToToman(price, { faDigits: false }) // '8,500 تومان'

And you can modify the suffix:

const price = 85_000
const toman = rialToToman(price, { suffix: false }) // '۸٫۵۰۰'

Or change it:

const price = 85_000
const toman = rialToToman(price, { suffix: ' ت' }) // '۸٫۵۰۰ ت'

You are able to combine options as well:

const price = 85_000
const toman = rialToToman(price, { faDigits: false, suffix: ' IRT' }) // '8,500 IRT'

Development

This project was created using bun init. Bun is a fast all-in-one JavaScript runtime.

To install dependencies:

bun install

To bundle:

bun run build

Generate types:

tsc

Lint without applying:

bun lint

Lint with applying safe fixes and formatting:

bun format

Run unit tests:

bun test --concurrent --randomize

In order to publish the package:

npm login

Create a tarball and check before publishing:

bun pm pack

Publish to npm:

bun publish