quran-meta
Version:
Library with meta data and functionality related to Holy Quran
85 lines (82 loc) • 2.86 kB
text/typescript
import { AyahId, AyahNo, Juz, Manzil, Ruku, Surah, SurahAyah } from "./types.cjs";
//#region src/typeGuards.d.ts
/**
* Checks if the given value is a valid AyahId.
*
* @param x - The value to check.
* @returns True if the value is a valid AyahId, otherwise false.
*/
declare function isValidAyahId(x: unknown): x is AyahId;
/**
* Checks if the given value is a valid Ayah number.
*
* @param x - The value to check.
* @returns True if the value is a valid Ayah number, otherwise false.
*/
declare function isValidAyahNo(x: unknown): x is AyahNo;
/**
* Checks if the given value is a valid Surah number.
*
* @param x - The value to check.
* @returns `true` if the value is a valid Surah number, otherwise `false`.
*/
declare function isValidSurah(x: unknown): x is Surah;
/**
* Type guard function that checks if a tuple of two numbers represents a valid Surah and Ayah combination.
*
* @param x - A tuple containing [surahNumber, ayahNumber]
* @returns True if the tuple represents a valid Surah-Ayah combination, false otherwise
*
* @example
* ```ts
* isValidSurahAyah([1, 7]) // true - Al-Fatiha has 7 ayahs
* isValidSurahAyah([1, 8]) // false - Al-Fatiha only has 7 ayahs
* isValidSurahAyah([115, 1]) // false - there are only 114 surahs
* ```
*/
declare function isValidSurahAyah(x: [unknown, unknown]): x is SurahAyah;
/**
* Type guard that checks if a number is a valid Juz number
* @param x - The number to check
* @returns True if the number is an integer between 1 and the total number of Juzs (inclusive)
*/
declare function isValidJuz(x: unknown): x is Juz;
/**
* Type guard to check if a number is a valid Hizb number
* @param x - The number to check
* @returns True if the number is an integer between 1 and the total number of Hizbs (inclusive)
*/
/**
* Type guard to check if a number is a valid Quran page number
* @param x - The number to check
* @returns True if the number is an integer between 1 and the total number of pages (inclusive)
*/
declare function isValidPage(x: unknown): x is Juz;
/**
* Type guard that checks if a value is a valid Ruku number
* @param x - The value to check
* @returns True if x is an integer between 1 and the total number of Rukus
* @example
* ```ts
* if (isValidRuku(5)) {
* // 5 is a valid Ruku number
* }
* ```
*/
declare function isValidRuku(x: unknown): x is Ruku;
/**
* Type guard to check if a value is a valid Manzil number
*
* @param x - The value to check
* @returns True if the value is an integer between 1 and the total number of Manzils
*
* @example
* ```ts
* if (isValidManzil(3)) {
* // value is a valid Manzil number
* }
* ```
*/
declare function isValidManzil(x: unknown): x is Manzil;
//#endregion
export { isValidAyahId, isValidAyahNo, isValidJuz, isValidManzil, isValidPage, isValidRuku, isValidSurah, isValidSurahAyah };