noobot-islam

noobot-islam is a TypeScript-first Islamic developer SDK for Node.js 20+. It provides a typed Quran engine, Arabic search normalization, audio and reciter provider boundaries, prayer and Qibla utilities, Hijri tools, data health checks, and optional database/API packages.

Install

npm install noobot-islam

Use it in TypeScript or modern JavaScript:

import { NoobotIslam } from "noobot-islam";

const islam = new NoobotIslam();
const ayah = islam.quran.getAyah("2:255");
const search = islam.search.search("الصلاة");
const ayahAudio = islam.audio.getAyahAudio({
  ayah: "2:255",
  reciter: "mishary"
});

console.log(ayah.text, search.length, ayahAudio.url);

You can also use the CLI:

npx noobot-islam quran 2:255
npx noobot search الصلاة
npx noobot data validate

Source-aware content

The package never generates Quran verses, hadith, tafsir, azkar, dua, sources, reciters, or references. Every built-in dataset has source metadata and a checksum. Content that requires a separate license must be supplied through a licensed provider rather than invented or silently redistributed.

The bundled Quran dataset carries an AlQuran Cloud source notice. Review the applicable provider terms before commercial publication, long-term caching, or redistribution of upstream data.

License

The SDK source code is released under the MIT License. Dataset notices remain subject to their original terms in LICENSES/.