Function ayahStringSplitter

  • ayahStringSplitter(str: string, isStrict?: boolean): SurahAyahSegment

    Splits a string representation of Quran reference into surah and ayah components

    Parameters

    • str: string

      The string to parse, expected format: "surah:ayah" or "surah:ayahStart-ayahEnd"

    • isStrict: boolean = true

      If true, enforces strict format checking. Defaults to true. If false, allows for additional characters in the string

    Returns SurahAyahSegment

    A tuple containing surah number and either a single ayah number or a range [start, end]

    Throws

    If the string format is invalid

    Throws

    If surah number is invalid

    Throws

    If ayah number(s) are invalid

    Throws

    If ayah range is invalid (start > end)

    Example

    ayahStringSplitter("2:255") // returns [2, 255]
    ayahStringSplitter("1:1-7") // returns [1, [1, 7]]

Settings

Member Visibility