search()

function search<TVerse extends VerseInput>(
  query: string,
  quranData: TVerse[],
  morphologyMap: Map<number, MorphologyAya>,
  wordMap: WordMap,
  options?: AdvancedSearchOptions,
  pagination?: PaginationOptions,
): SearchResponse<TVerse>

import {
  search,
  loadQuranData,
  loadMorphology,
  loadWordMap,
} from 'quran-search-engine';

const [quranData, morphologyMap, wordMap] = await Promise.all([
  loadQuranData(),
  loadMorphology(),
  loadWordMap(),
]);

const response = search(
  'الله الرحمن',
  quranData,
  morphologyMap,
  wordMap,
  { lemma: true, root: true },
);

response.results.forEach((v) => {
  console.log(v.sura_id, v.aya_id, v.matchType, v.matchScore);
});
// Output:
// 1 1 exact 6
// 1 3 lemma 4

const response = search(
  'الله الرحمن',
  quranData,
  morphologyMap,
  wordMap,
  { lemma: true, root: true },
  { page: 1, limit: 10 },
);

console.log(response.pagination);
// Output:
// {
//   totalResults: 42,
//   totalPages: 5,
//   currentPage: 1,
//   limit: 10
// }

console.log(response.counts);
// Output:
// {
//   simple: 10,
//   lemma: 18,
//   root: 9,
//   fuzzy: 5,
//   total: 42
// }

const response = search(
  'الله',
  quranData,
  morphologyMap,
  wordMap,
  { lemma: true, root: true, fuzzy: false },
);

// Only returns exact, lemma, and root matches
// No fuzzy fallback for tokens without matches

import { search, type VerseInput } from 'quran-search-engine';

type MyVerse = VerseInput & {
  sura: number;
  aya: number;
  translation_en?: string;
};

const myQuranData: MyVerse[] = [
  {
    gid: 1,
    standard: 'بسم الله الرحمن الرحيم',
    uthmani: 'بِسْمِ ٱللَّهِ ٱلرَّحْمَٰنِ ٱلرَّحِيمِ',
    sura: 1,
    aya: 1,
    translation_en: 'In the name of Allah...',
  },
];

const response = search(
  'الله الرحمن',
  myQuranData,
  new Map(),
  {},
  { lemma: false, root: false },
);

console.log(response.results[0]);
// Output includes custom fields: sura, aya, translation_en