quran-meta/lib_cjs/surahStringParser.d.cts

Library with meta data and functionality related to Holy Quran

import { Surah } from "./types.cjs";

//#region src/surahStringParser.d.ts

/**
 * Parses a string representation of a Surah number and converts it to a valid Surah type
 * @param str - The string containing the Surah number to parse
 * @returns The parsed Surah number as a Surah type
 * @throws {@link Error} If the string cannot be parsed as a number or if the number is not a valid Surah number
 */
declare function surahStringParser(str: string, isStrict?: boolean): Surah;
//#endregion
export { surahStringParser };