starkstring
A simple JavaScript library To use the most commonly used string operations.
Include functions of persian.js
TOC
install
$ yarn add starkstring
const starkString = require("starkstring").default;
//or
import starkString from "starkstring";Functions
1) Convert Arabic characters to Persian
Used for converting Arabic characters to Persian.
Example:
starkString(" علي ")
.trim() // Remove spaces
.persianChar() // Convert arabic `ي` to persian `ی`
.toString(); //Returns: "علی"2) Convert to English numbers from Persian and arabic Number
Used for converting Persian and arabic Number to English numbers.
Example:
starkString("۳۴۵ ٤٥")
.englishNumber()
.toString(); //returns: 345 453) Convert to Persian numbers from Arabic and English Number
Used for converting Arabic and English numbers to Persian.
Example:
starkString("٣٤٥ 78")
.persianNumber()
.toString(); //returns: ۳۴۵ ۷۸4) Convert to Arabic numbers from English and Persian Number
Used for converting Arabic and Persian numbers to English.
Example:
starkString("345")
.arabicNumber()
.toString(); //returns: ٣٤٥6) Decode Percent-encoding Characters in URLs
Used to normalize url
Example:
starkString(
"fa.wikipedia.org/wiki/%D8%B5%D9%81%D8%AD%D9%87%D9%94_%D8%A7%D8%B5%D9%84%DB%8C",
)
.fixURL()
.toString(); //returns http://fa.wikipedia.org/wiki/%D8%B5%D9%81%D8%AD%D9%87%D9%94_%D8%A7%D8%B5%D9%84%DB%8C/7) Change keyboard layout
Used for converting Persian char to English char.
Example:
starkString("لخخلمث")
.switchKey()
.toString(); //returns: google8) Convert numbers to words
Used for representing numbers as Persian words.
Example:
starkString("1372")
.digitsToWords()
.toString(); //returns: یک هزار و سیصد و هفتاد و دو9) Zero-width non-joiner correction
Example:
starkString("آمده ای ولی من رفته ام و می آییم")
.halfSpace()
.toString(); //returns: آمدهای ولی من رفتهام و میآییم10) Integer number validation
Whether is value integer
Example:
starkString("344327905").isInteger(); // return true
starkString("34432.7905").isInteger(); // return false
starkString("g344327905").isInteger(); // return false11) bank card number validation
Whether is value bank card
Example:
starkString("6104337638408961").isValidBankCard(); // return true12) convert number to currency format
convert english number to currency format
Example:
starkString("120000.00")
.currency()
.toString(); // return 120,000.00
starkString("120000")
.currency()
.persianNumber()
.toString(); // return ۱۲۰,۰۰۰13) Parse Numbers
Remove anything expect numbers
Example:
starkString(" amount 12,000 dollar")
.parseNumber()
.toString(); // return 1200014) security string
convert any char to star ("*")
Example:
starkString("password")
.security()
.toString(); // return ********Chainable using
You can use all of the functions together with one StarkString instance.
Example:
starkString("علي٤2465")
.persianChar()
.englishNumber()
.persianNumber()
.toString(); //returns: علی۴۲۴۶۵Contributing
This is a open-source project. Fork the project, complete the code and send pull request.