amirkenarang/persian-normalizer

Normalize Persian Text

A Package for normalizing text and number to persian

Table of contents

• Table of contents
  • Installation
• Quick Start
• Usage
• What is it?
• Change Log
• Contributing
• Author
• License

Installation

npm install --save persian-normalizer

yarn add persian-normalizer

Quick Start

Check out the Examples in ./examples.

Don't see an example you think should be there? Submit a pull request to add it!

Usage

The simplest way to check convert english or arabic text and number to persian. Also, it create a search field for persian search in databases:

Import in Typescipt:

import { normalizePersianTex} from "persian-normalizer";

Import in Javascript files:

const { normalizePersianText } = require("persian-normalizer");

Example usag:

import {
  normalizePersianTex,
  extractNumbers,
  persianToEnglishNumber,
  removeSpaces,
  createSearchField,
  isEnglish,
} from "persian-normalizer";

const result1 = normalizePersianText(" علیـ ٌِرضآ امئر ٌ");
const result2 = extractNumbers("a٠١۳٣٤٥٦٧٨٩");
const result3 = persianToEnglishNumber("a٠١۳٣٤٥٦٧٨٩");
const result4 = removeSpaces("امیر ali");
const result5 = createSearchField("امیر علءئ شهر اّصفهان");
const result6 = isEnglish("amir امیر");

Results are like this:

// result1 = علیرضآامیر
// result2 = 0133456789
// result3 = a011473456789
// result4 = امیرali
// result5 = امیرعلءیشهراّصفهان
// result6 = false

What is it?

This package was developed to remove extra Persian and Arabic characters from text. It will convert Arabic text to Persian and normalize it for searching in databases. Also, it converts Persian and English numbers to English Numbers.

Change Log

See Changelog for more information.

Contributing

Contributions welcome! See Contributing.

Author

Amir Kenarang

Email: [email protected]

Website: www.amirkenarang.me

License

Licensed under the MIT License - see the LICENSE file for details.