quran-meta/lib_es/index.d.mts

Library with meta data and functionality related to Holy Quran

import { AyahCountBetweenJuzSurah, AyahId, AyahMeta, AyahNo, AyahRange, HizbId, Juz, JuzMeta, JuzPart, Manzil, ManzilMeta, Page, PageMeta, QuranMeta, RangeMeta, RangeMode, RubAlHizb, RubAlHizbId, RubAlHizbMeta, Ruku, RukuMeta, Surah, SurahAyah, SurahAyahSegment, SurahInfo, SurahJuzMeta, SurahListType, SurahMeta, SurahName } from "./types.mjs";
import { QuranRiwaya } from "./QuranRiwaya.mjs";
import { generatePartBlocks, getList, getListNormalised } from "./lists/getList.mjs";
import { getListOfRiwaya, getListsOfRiwaya } from "./lists/index.mjs";
import { ayahStringSplitter, string2NumberSplitter, string2NumberSplitterStrict } from "./ayahStringSplitter.mjs";
import { surahStringParser } from "./surahStringParser.mjs";
import { findAyahIdBySurah } from "./findAyahIdBySurah.mjs";
import { findJuz } from "./findJuz.mjs";
import { findJuzAndShift, findJuzAndShiftByAyahId } from "./findJuzAndShift.mjs";
import { findJuzByAyahId } from "./findJuzByAyahId.mjs";
import { findJuzMetaBySurah } from "./findJuzMetaBySurah.mjs";
import { findManzil } from "./findManzil.mjs";
import { findManzilByAyahId } from "./findManzilByAyahId.mjs";
import { findPage } from "./findPage.mjs";
import { findPagebyAyahId } from "./findPagebyAyahId.mjs";
import { findRangeAroundAyah } from "./findRangeAroundAyah.mjs";
import { findRangeAroundSurahAyah } from "./findRangeAroundSurahAyah.mjs";
import { findRubAlHizb } from "./findRubAlHizb.mjs";
import { findRubAlHizbByAyahId } from "./findRubAlHizbByAyahId.mjs";
import { findRukuByAyahId } from "./findRukuByAyahId.mjs";
import { findSurahAyahByAyahId } from "./findSurahAyahByAyahId.mjs";
import { findSurahByAyahId } from "./findSurahByAyahId.mjs";
import { getAyahCountInSurah } from "./getAyahCountInSurah.mjs";
import { getAyahMeta } from "./getAyahMeta.mjs";
import { getAyahMetasForSurah } from "./getAyahMetasForSurah.mjs";
import { getJuzMeta } from "./getJuzMeta.mjs";
import { getManzilMeta } from "./getManzilMeta.mjs";
import { getPageMeta } from "./getPageMeta.mjs";
import { getRukuMeta } from "./getRukuMeta.mjs";
import { getRubAlHizb } from "./getRubAlHizb.mjs";
import { getRubAlHizbMeta } from "./getRubAlHizbMeta.mjs";
import { getRubAlHizbMetaByAyahId } from "./getRubAlHizbMetaByAyahId.mjs";
import { getRubAlHizbByAyahId } from "./getRubAlHizbByAyahId.mjs";
import { getSurahMeta } from "./getSurahMeta.mjs";
import { isAyahJuzFirst } from "./isAyahJuzFirst.mjs";
import { isAyahPageFirst } from "./isAyahPageFirst.mjs";
import { isSurahAyahJuzFirst } from "./isSurahAyahJuzFirst.mjs";
import { isSurahAyahPageFirst } from "./isSurahAyahPageFirst.mjs";
import { nextAyah } from "./nextAyah.mjs";
import { prevAyah } from "./prevAyah.mjs";
import { isValidAyahId, isValidAyahNo, isValidJuz, isValidManzil, isValidPage, isValidRuku, isValidSurah, isValidSurahAyah } from "./typeGuards.mjs";
import { checkValidAyahId, checkValidJuz, checkValidManzil, checkValidPage, checkValidRuku, checkValidSurah, checkValidSurahAyah } from "./validation.mjs";
import { Lang, SurahNames, SurahNamesI18n } from "./i18n/types.mjs";
import { surahNamesEn } from "./i18n/surah.en.mjs";
import { surahNamesAz } from "./i18n/surah.az.mjs";
import { surahNamesRu } from "./i18n/surah.ru.mjs";
import { surahNamesTr } from "./i18n/surah.tr.mjs";
import { getSurahNames } from "./i18n/getSurahNames.mjs";
import { surahNames } from "./i18n/index.mjs";

//#region src/index.d.ts
/**
 * Create a QuranRiwaya instance with Hafs riwaya (default)
 */
declare const createHafs: () => QuranRiwaya<"Hafs" | "Qalun" | "Warsh">;
/**
 * Create a QuranRiwaya instance with Qalun riwaya
 */
declare const createQalun: () => QuranRiwaya<"Hafs" | "Qalun" | "Warsh">;
/**
 * Create a QuranRiwaya instance with Warsh riwaya
 */
declare const createWarsh: () => QuranRiwaya<"Hafs" | "Qalun" | "Warsh">;
/**
 * Pre-initialized QuranRiwaya instance for Hafs (for convenience)
 */
declare const quran: QuranRiwaya<"Hafs" | "Qalun" | "Warsh">;
//#endregion
export { type AyahCountBetweenJuzSurah, type AyahId, type AyahMeta, type AyahNo, type AyahRange, type HizbId, type Juz, type JuzMeta, type JuzPart, Lang, type Manzil, type ManzilMeta, type Page, type PageMeta, type QuranMeta, QuranRiwaya, type RangeMeta, type RangeMode, type RubAlHizb, type RubAlHizbId, type RubAlHizbMeta, type Ruku, type RukuMeta, type Surah, type SurahAyah, type SurahAyahSegment, type SurahInfo, type SurahJuzMeta, type SurahListType, type SurahMeta, type SurahName, SurahNames, SurahNamesI18n, ayahStringSplitter, checkValidAyahId, checkValidJuz, checkValidManzil, checkValidPage, checkValidRuku, checkValidSurah, checkValidSurahAyah, createHafs, createQalun, createWarsh, findAyahIdBySurah, findJuz, findJuzAndShift, findJuzAndShiftByAyahId, findJuzByAyahId, findJuzMetaBySurah, findManzil, findManzilByAyahId, findPage, findPagebyAyahId, findRangeAroundAyah, findRangeAroundSurahAyah, findRubAlHizb, findRubAlHizbByAyahId, findRukuByAyahId, findSurahAyahByAyahId, findSurahByAyahId, generatePartBlocks, getAyahCountInSurah, getAyahMeta, getAyahMetasForSurah, getJuzMeta, getList, getListNormalised, getListOfRiwaya, getListsOfRiwaya, getManzilMeta, getPageMeta, getRubAlHizb, getRubAlHizbByAyahId, getRubAlHizbMeta, getRubAlHizbMetaByAyahId, getRukuMeta, getSurahMeta, getSurahNames, isAyahJuzFirst, isAyahPageFirst, isSurahAyahJuzFirst, isSurahAyahPageFirst, isValidAyahId, isValidAyahNo, isValidJuz, isValidManzil, isValidPage, isValidRuku, isValidSurah, isValidSurahAyah, nextAyah, prevAyah, quran, string2NumberSplitter, string2NumberSplitterStrict, surahNames, surahNamesAz, surahNamesEn, surahNamesRu, surahNamesTr, surahStringParser };