fa-utils

Useful Persian utilities

This is a combination of simple but useful persian-related functions (number modifiers for now).

Installation

npm:

npm install fa-utils

Usage

ES6:

import { toEnDigit, toFaDigit, toArDigit, toAbbrNumber } from 'fa-utils'

ES5 / CommonJS:

var { toEnDigit, toFaDigit, toArDigit, toAbbrNumber } = require('fa-utils')

Examples

The Input and Output of each function is shown in examples blow.

• toEnDigit()

  Convert Persian/Arabic numbers to English:

  toEnDigit("۱۲۳۴۵۶۷۸۹۰")    // returns: "1234567890"
  toEnDigit("١٢٣٤٥٦٧٨٩۰")    // returns: "1234567890"
  toEnDigit("fa۱۲۳۴ ar١٢٣٤") // returns: "fa1234 ar1234"
  toEnDigit("۱۲۳.۴۵")        // returns: "123.45"

• toFaDigit()

  Convert English/Arabic numbers to Persian:

  toFaDigit(1234567890)      // returns: "۱۲۳۴۵۶۷۸۹۰"
  toFaDigit("1234567890")    // returns: "۱۲۳۴۵۶۷۸۹۰"
  toFaDigit("١٢٣٤٥٦٧٨٩۰")    // returns: "۱۲۳۴۵۶۷۸۹۰"
  toFaDigit("123.45")        // returns: "۱۲۳.۴۵"

• toArDigit()

  Convert English/Persian numbers to Arabic:

  toArDigit(1234567890)      // returns: "١٢٣٤٥٦٧٨٩٠"
  toArDigit("1234567890")    // returns: "١٢٣٤٥٦٧٨٩٠"
  toArDigit("۱۲۳۴۵۶۷۸۹۰")    // returns: "١٢٣٤٥٦٧٨٩٠"
  toArDigit("123.45")        // returns: "١٢٣.٤٥"

• toAbbrNumber()

  Shortens numbers by adding symbols:

  toAbbrNumber(710)      // returns: "710"
  toAbbrNumber(4861)    // returns: "4.9K"
  toAbbrNumber(14211793.45)    // returns: "14.2M"
  toAbbrNumber(-356199)        // returns: "-356.2K"

Release History

• 0.1.5
  • Add toAbbrNumber method
• 0.1.4
  • Bug fix
• 0.1.3
  • Add TypeScript type declaration (Thanks to @geopic)
• 0.1.2
  • Add autocomplete for methods
• 0.1.1
  • Add Readme
• 0.1.0
  • Initial Release

License

Distributed under the ISC license. See LICENSE for more information.

Contributing

All contributions are welcome and I appreciate them. Including adding new functionality or improve current ones. (Even fixing typos)

1. Fork it (https://github.com/AhmadMaleki/fa-utils/fork)
2. Create your feature branch (git checkout -b feature/fooBar)
3. Commit your changes (git commit -am 'Add some fooBar')
4. Push to the branch (git push origin feature/fooBar)
5. Create a new Pull Request

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!