@6degrees/arabic-strings - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

CHANGELOG.md

 # @6degrees/arabic-strings
 
+## 0.1.1
+
+### Patch Changes
+
+- edit readme
+
 ## 0.1.0
@@ -4,0 +10,0 @@

package.json

 {
   "name": "@6degrees/arabic-strings",
   "license": "MIT",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "main": "dist/index.js",
@@ -6,0 +6,0 @@ "module": "dist/index.mjs",

README.md

@@ -11,6 +11,7 @@ # arabicStrings
 ```js
-require('arabicString')
+const arabicString = require('@6degrees/arabic-strings');
 ```
-##String#howArabic()
 
+## String#howArabic()
+
 The percentage of Arabic letters in the `String`.
@@ -21,11 +22,13 @@
 ```js
-'foobar'.howArabic()
+arabicString.howArabic('foobar');
 //=> 0.0
-'فوو bar'.howArabic()
+
+arabicString.howArabic('فوو bar');
 //=> 0.5
-'فوبار'.howArabic()
+
+arabicString.howArabic('فوبار');
 //=> 1.0
 ```
 
-##String#howNotArabic()
+## String#howNotArabic()
 
@@ -37,7 +40,9 @@ The percentage of non-Arabic letters in the `String`.
 ```js
-'فوبار'.howNotArabic()
+arabicString.howNotArabic('فوبار');
 //=> 0.0
-'فوو bar'.howNotArabic()
+
+arabicString.howNotArabic('فوو bar');
 //=> 0.5
-'foobar'.howNotArabic()
+
+arabicString.howNotArabic('foobar');
 //=> 1.0
@@ -53,5 +58,6 @@ ```
 ```js
-'فوو'.isArabic()
+arabicString.isArabic('فوو');
+
 //=> true
-'فوو bar baz'.isArabic(0.5)
+arabicString.isArabic('فوو bar baz');
 //=> false
@@ -67,5 +73,6 @@ ```
 ```js
-'فوو bar'.hasArabic()
+arabicString.hasArabic('فوو bar');
 //=> ture
-'foo bar'.hasArabic()
+
+arabicString.hasArabic('foo bar');
 //=> false
@@ -81,9 +88,10 @@ ```
 ```js
-'مٌحمْد'.removeTashkel()
+arabicString.removeTashkel('مٌحمْد');
 //=> 'محمد'
-'وَتُرى الْكَوَاكِبِ فِي الْمَجَرَّةِ شَرَعَا*** مِثْلُ الظِّباءِ كوارعا فِي جَدْوَلِ'.removeTashkel()
+
+arabicString.removeTashkel('وَتُرى الْكَوَاكِبِ فِي الْمَجَرَّةِ شَرَعَا*** مِثْلُ الظِّباءِ كوارعا فِي جَدْوَلِ');
 //=> 'وترى الكواكب في المجرة شرعا *** مثل الظباء كوارعا في جدول'
 ```
 
-##String#removeTatwel()
+## String#removeTatwel()
 
@@ -95,8 +103,24 @@ Will return the `String` without the diacritics.
 ```js
-'مــرحــبــا'.removeTatwel()
+arabicString.removeTatwel('مــرحــبــا');
 //=> 'مرحبا'
 ```
 
+## String#sanitize()
 
+Will return the `String` without the diacritics, and clean characters.
 
+### Example
+
+```js
+arabicString.sanitize(`أَنا الَّذي نَظَرَ الأَعمى إِلى أَدَبي ... وَأَسمَـعَت كَلِماتي مَن بِهِ صَمَمُ
+أَنـامُ مِلءَ جُفوني عَن شَوارِدِهــا ... وَيَسهَرُ الخَلقُ جَرّاها وَيَختَصِمُ
+وَجـــاهِلٍ مَدَّهُ في جَهلِهِ ضَحِكي ... حَتّى أَتَتهُ يَدٌ فَرّاسَــــــةٌ وَفَـــــمُ
+`);
+/*=> `انا الذي نظر الاعمي الي ادبي ... واسمعت كلماتي من به صمم
+انام ملء جفوني عن شواردها ... ويسهر الخلق جراها ويختصم
+وجاهل مده في جهله ضحكي ... حتي اتته يد فراسه وفم
+`
+*/
+```
+
 ## Credits
@@ -103,0 +127,0 @@

No alert changes

Improved metrics

Total package byte prevSize

17625

increased by6.95%

Number of lines in readme file

128

increased by23.08%

No dependency changes