Documentation Index
Fetch the complete documentation index at: https://mintlify.com/adelpro/quran-search-engine/llms.txt
Use this file to discover all available pages before exploring further.
Function signature
export const normalizeArabic = (text: string): string
Parameters
The input Arabic text to normalize
Returns
The normalized string with all transformations applied
- Removes tashkeel (diacritics) - Strips all diacritical marks and Quranic symbols
- Unicode normalization - Applies NFC (Canonical Decomposition followed by Canonical Composition)
- Removes dagger alif and tatweel - Removes U+0670 (dagger alif) and U+0640 (tatweel/kashida)
- Unifies alef variants - Converts إ أ آ ٱ → ا (regular alef)
- Unifies hamza variants - Converts ؤ ئ ء → ء (standalone hamza)
- Unifies alif maqsura - Converts ى → ي (yaa)
- Removes control characters - Strips CRLF and non-Arabic symbols
- Normalizes whitespace - Replaces multiple spaces with single space
- Trims whitespace - Removes leading and trailing whitespace
Use case
Preparing user input for searching. This function unifies alef variants, removes tashkeel, and normalizes text to ensure consistent matching across different writing styles.
Examples
Basic normalization
import { normalizeArabic } from 'quran-search-engine';
const out = normalizeArabic('بِسْمِ ٱللَّهِ');
console.log(out);
// Output: 'بسم الله'
Before and after
import { normalizeArabic } from 'quran-search-engine';
// Input with diacritics and variant characters
const input = 'بِسْمِ ٱللَّهِ ٱلرَّحْمَٰنِ ٱلرَّحِيمِ';
console.log('Before:', input);
const output = normalizeArabic(input);
console.log('After:', output);
// Before: بِسْمِ ٱللَّهِ ٱلرَّحْمَٰنِ ٱلرَّحِيمِ
// After: بسم الله الرحمن الرحيم
Using in search filter
import { normalizeArabic } from 'quran-search-engine';
export function containsAllTokens(value: string, query: string): boolean {
const normalizedQuery = normalizeArabic(query);
if (!normalizedQuery) return false;
const tokens = normalizedQuery.split(/\s+/);
const normalizedValue = normalizeArabic(value);
return tokens.every((token) => normalizedValue.includes(token));
}
import { normalizeArabic } from 'quran-search-engine';
const result = normalizeArabic('');
console.log(result);
// Output: ''