starkstring

A simple JavaScript library To use the most commonly used string operations.
Include functions of persian.js

TOC

- install
- Functions
- Contributing

install

$ yarn add starkstring

``js
const starkString = require("starkstring").default;

//or

import starkString from "starkstring";
`

Functions

$3

Used for converting Arabic characters to Persian.

Example:

`javascript
starkString(" علي ")
.trim() // Remove spaces
.persianChar() // Convert arabic ي to persian ی
.toString(); //Returns: "علی"
`

---

$3

Used for converting Persian and arabic Number to English numbers.

Example:

`javascript
starkString("۳۴۵ ٤٥")
.englishNumber()
.toString(); //returns: 345 45
`

---

$3

Used for converting Arabic and English numbers to Persian.

Example:

`javascript
starkString("٣٤٥ 78")
.persianNumber()
.toString(); //returns: ۳۴۵ ۷۸
`

---

$3

Used for converting Arabic and Persian numbers to English.

Example:

`javascript
starkString("345")
.arabicNumber()
.toString(); //returns: ٣٤٥
`

---

$3

Used to normalize url

Example:

`javascript
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/
`

---

$3

Used for converting Persian char to English char.

Example:

`javascript
starkString("لخخلمث")
.switchKey()
.toString(); //returns: google
`

---

$3

Used for representing numbers as Persian words.

Example:

`javascript
starkString("1372")
.digitsToWords()
.toString(); //returns: یک هزار و سیصد و هفتاد و دو
`

---

$3

Example:

`javascript
starkString("آمده ای ولی من رفته ام و می آییم")
.halfSpace()
.toString(); //returns: آمده‌ای ولی من رفته‌ام و می‌آییم
`

---

$3

Whether is value integer

Example:

`javascript
starkString("344327905").isInteger(); // return true

starkString("34432.7905").isInteger(); // return false
starkString("g344327905").isInteger(); // return false
`

---

$3

Whether is value bank card

Example:

`javascript
starkString("6104337638408961").isValidBankCard(); // return true
`

---

$3

convert english number to currency format

Example:

`javascript
starkString("120000.00")
.currency()
.toString(); // return 120,000.00

starkString("120000")
.currency()
.persianNumber()
.toString(); // return ۱۲۰,۰۰۰
`

---

$3

Remove anything expect numbers

Example:

`javascript
starkString(" amount 12,000 dollar")
.parseNumber()
.toString(); // return 12000
`

---

$3

convert any char to star ("\*")

Example:

`javascript
starkString("password")
.security()
.toString(); // return **
`

---

$3

You can use all of the functions together with one StarkString instance.

Example:

`javascript
starkString("علي٤2465")
.persianChar()
.englishNumber()
.persianNumber()
.toString(); //returns: علی۴۲۴۶۵
``

---

Contributing

This is a open-source project. Fork the project, complete the code and send pull request.