1 | [![NPM](https://nodei.co/npm/starkstring.png)](https://nodei.co/npm/starkstring/)
|
2 |
|
3 | [![install size](https://packagephobia.now.sh/badge?p=starkstring)](https://packagephobia.now.sh/result?p=starkstring) [![dependencies](https://david-dm.org/hosseinmd/starkstring.svg)](https://david-dm.org/hosseinmd/starkstring.svg)
|
4 |
|
5 | # [starkstring](http://github.com/hosseinmd/starkString)
|
6 |
|
7 | A simple JavaScript library To use the most commonly used string operations.
|
8 | Include functions of `persian.js`
|
9 |
|
10 | ## TOC
|
11 |
|
12 | - [install](#install)
|
13 | - [Functions](#Functions)
|
14 | - [Contributing](#Contributing)
|
15 |
|
16 | ## install
|
17 |
|
18 | `$ yarn add starkstring`
|
19 |
|
20 | ```js
|
21 | const starkString = require("starkstring");
|
22 |
|
23 | //or
|
24 |
|
25 | import starkString from "starkstring";
|
26 | ```
|
27 |
|
28 | ## Functions
|
29 |
|
30 | ### 1) Convert Arabic characters to Persian
|
31 |
|
32 | Used for converting Arabic characters to Persian.
|
33 |
|
34 | Example:
|
35 |
|
36 | ```javascript
|
37 | starkString(" علي ")
|
38 | .trim()
|
39 | .persianChar()
|
40 | .toString(); //returns: علی
|
41 | ```
|
42 |
|
43 | ---
|
44 |
|
45 | ### 2) Convert to English numbers from Persian and arabic Number
|
46 |
|
47 | Used for converting Persian and arabic Number to English numbers.
|
48 |
|
49 | Example:
|
50 |
|
51 | ```javascript
|
52 | starkString("۳۴۵ ٤٥")
|
53 | .englishNumber()
|
54 | .toString(); //returns: 345 45
|
55 | ```
|
56 |
|
57 | ---
|
58 |
|
59 | ### 3) Convert to Persian numbers from Arabic and English Number
|
60 |
|
61 | Used for converting Arabic and English numbers to Persian.
|
62 |
|
63 | Example:
|
64 |
|
65 | ```javascript
|
66 | starkString("٣٤٥ 78")
|
67 | .persianNumber()
|
68 | .toString(); //returns: ۳۴۵ ۷۸
|
69 | ```
|
70 |
|
71 | ---
|
72 |
|
73 | ### 4) Convert to Arabic numbers from English and Persian Number
|
74 |
|
75 | Used for converting Arabic and Persian numbers to English.
|
76 |
|
77 | Example:
|
78 |
|
79 | ```javascript
|
80 | starkString("345")
|
81 | .arabicNumber()
|
82 | .toString(); //returns: ٣٤٥
|
83 | ```
|
84 |
|
85 | ---
|
86 |
|
87 | ### 6) Decode Percent-encoding Characters in URLs
|
88 |
|
89 | Used to convert unreadable Persian characters in URL to readable characters.
|
90 |
|
91 | Example:
|
92 |
|
93 | ```javascript
|
94 | starkString(
|
95 | "https://fa.wikipedia.org/wiki/%D8%B5%D9%81%D8%AD%D9%87%D9%94_%D8%A7%D8%B5%D9%84%DB%8C",
|
96 | )
|
97 | .fixURL()
|
98 | .toString(); //returns https://fa.wikipedia.org/wiki/صفحهٔ_اصلی
|
99 | ```
|
100 |
|
101 | ---
|
102 |
|
103 | ### 7) Change keyboard layout
|
104 |
|
105 | Used for converting Persian char to English char.
|
106 |
|
107 | Example:
|
108 |
|
109 | ```javascript
|
110 | starkString("لخخلمث")
|
111 | .switchKey()
|
112 | .toString(); //returns: google
|
113 | ```
|
114 |
|
115 | ---
|
116 |
|
117 | ### 8) Convert numbers to words
|
118 |
|
119 | Used for representing numbers as Persian words.
|
120 |
|
121 | Example:
|
122 |
|
123 | ```javascript
|
124 | starkString("1372")
|
125 | .digitsToWords()
|
126 | .toString(); //returns: یک هزار و سیصد و هفتاد و دو
|
127 | ```
|
128 |
|
129 | ---
|
130 |
|
131 | ### 9) Zero-width non-joiner correction
|
132 |
|
133 | Example:
|
134 |
|
135 | ```javascript
|
136 | starkString("آمده ای ولی من رفته ام و می آییم")
|
137 | .halfSpace()
|
138 | .toString(); //returns: آمدهای ولی من رفتهام و میآییم
|
139 | ```
|
140 |
|
141 | ---
|
142 |
|
143 | ### 10) Integer number validation
|
144 |
|
145 | Whether is value integer
|
146 |
|
147 | Example:
|
148 |
|
149 | ```javascript
|
150 | starkString("344327905").isInteger(); // return true
|
151 |
|
152 | starkString("34432.7905").isInteger(); // return false
|
153 | starkString("g344327905").isInteger(); // return false
|
154 | ```
|
155 |
|
156 | ---
|
157 |
|
158 | ### 11) bank card number validation
|
159 |
|
160 | Whether is value bank card
|
161 |
|
162 | Example:
|
163 |
|
164 | ```javascript
|
165 | starkString("6104337638408961").isValidBankCard(); // return true
|
166 | ```
|
167 |
|
168 | ---
|
169 |
|
170 | ### 12) convert number to currency format
|
171 |
|
172 | convert english number to currency format
|
173 |
|
174 | Example:
|
175 |
|
176 | ```javascript
|
177 | starkString("120000.00")
|
178 | .currency()
|
179 | .toString(); // return 120,000.00
|
180 |
|
181 | starkString("120000")
|
182 | .currency()
|
183 | .persianNumber()
|
184 | .toString(); // return ۱۲۰,۰۰۰
|
185 | ```
|
186 |
|
187 | ---
|
188 |
|
189 | ### 13) Parse Numbers
|
190 |
|
191 | Remove anything expect numbers
|
192 |
|
193 | Example:
|
194 |
|
195 | ```javascript
|
196 | starkString(" amount 12,000 dollar")
|
197 | .parseNumber()
|
198 | .toString(); // return 12000
|
199 | ```
|
200 |
|
201 | ---
|
202 |
|
203 | ### 14) security string
|
204 |
|
205 | convert any char to star ("\*")
|
206 |
|
207 | Example:
|
208 |
|
209 | ```javascript
|
210 | starkString("password")
|
211 | .security()
|
212 | .toString(); // return ********
|
213 | ```
|
214 |
|
215 | ---
|
216 |
|
217 | ### Chainable using
|
218 |
|
219 | You can use all of the functions together with one StarkString instance.
|
220 |
|
221 | Example:
|
222 |
|
223 | ```javascript
|
224 | starkString("علي٤2465")
|
225 | .persianChar()
|
226 | .englishNumber()
|
227 | .persianNumber()
|
228 | .toString(); //returns: علی۴۲۴۶۵
|
229 | ```
|
230 |
|
231 | ---
|
232 |
|
233 | ## Contributing
|
234 |
|
235 | This is a open-source project. Fork the project, complete the code and send pull request.
|