Installation

Package manager installation

Install quran-search-engine using your preferred package manager:

npm install quran-search-engine

yarn add quran-search-engine

pnpm install quran-search-engine

This project uses pnpm as the default package manager for optimal performance, caching, and workspace management. pnpm provides faster installs, efficient disk usage, better workspace support, and strict dependency resolution.

Package information

Package name: quran-search-engine
Latest version: 0.1.5
License: MIT
TypeScript: Full TypeScript support with type definitions included

Module formats

The package supports both CommonJS and ESM:

{
  "main": "./dist/index.js",      // CommonJS
  "module": "./dist/index.mjs",   // ESM
  "types": "./dist/index.d.ts"    // TypeScript definitions
}

Import examples

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

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

const { search, loadQuranData, loadMorphology, loadWordMap } = require('quran-search-engine');

Requirements

Node.js: 18+ (for async/await support)
TypeScript: 5.0+ (if using TypeScript)

The library works in both browser and Node.js environments. Examples in the documentation assume an async context (Node 18+, ESM, or browser).

Verify installation

After installation, verify the package is working:

import { loadQuranData } from 'quran-search-engine';

const quranData = await loadQuranData();
console.log(`Loaded ${quranData.length} verses`);
// Expected output: Loaded 6236 verses

Next steps

Quick start

Build your first search in 5 minutes

Get Started

Core Concepts

Guides

Examples

Package manager installation

Package information

Module formats

Import examples

Requirements

Verify installation

Next steps

Quick start

​Package manager installation

​Package information

​Module formats

​Import examples

​Requirements

​Verify installation

​Next steps

Quick start

Package manager installation

Package information

Module formats

Import examples

Requirements

Verify installation

Next steps