@6degrees/arabic-strings

arabicStrings

An NPM package that extends the native String object with methods to help when dealing with Arabic strings for node and the browser.

NPM updated package of @ahmads/arabicString repo

Usage

node

require('arabicString')

##String#howArabic()

The percentage of Arabic letters in the String.

Example

'foobar'.howArabic()
//=> 0.0
'فوو bar'.howArabic()
//=> 0.5
'فوبار'.howArabic()
//=> 1.0

##String#howNotArabic()

The percentage of non-Arabic letters in the String.

Example

'فوبار'.howNotArabic()
//=> 0.0
'فوو bar'.howNotArabic()
//=> 0.5
'foobar'.howNotArabic()
//=> 1.0

String#isArabic(threshold)

Is the String Arabic, based on a given threshold between 0 and 1. Defaults to 0.79.

Example

'فوو'.isArabic()
//=> true
'فوو bar baz'.isArabic(0.5)
//=> false

String#hasArabic()

Does the String have any Arabic letter.

Example

'فوو bar'.hasArabic()
//=> ture
'foo bar'.hasArabic()
//=> false

String#removeTashkel()

Will return the String without the diacritics.

Example

'مٌحمْد'.removeTashkel()
//=> 'محمد'
'وَتُرى الْكَوَاكِبِ فِي الْمَجَرَّةِ شَرَعَا*** مِثْلُ الظِّباءِ كوارعا فِي جَدْوَلِ'.removeTashkel()
//=> 'وترى الكواكب في المجرة شرعا *** مثل الظباء كوارعا في جدول'

##String#removeTatwel()

Will return the String without the diacritics.

Example

'مــرحــبــا'.removeTatwel()
//=> 'مرحبا'

Credits

• Original script [https://github.com/ahmads/arabicString]
• Enhancements [https://github.com/ahmads/arabicString/pulls]

License

(The MIT License)

Changelog

0.0.3

Patch Changes

• modified to class, removed proto.strings implementation, added the pull request

  • changed to class instead of ammending the string.proto
  • implemented pull request [https://github.com/ahmads/arabicString/pull/4/files]