Function string2NumberSplitterStrict

  • string2NumberSplitterStrict(
        str: string,
    ): null | { ayah?: number; ayahTo?: number; surahOrAyah?: number }

    Splits a string in the format "surah:ayah" or "surah:ayah-ayah" into its numeric components.

    Parameters

    • str: string

      The input string to parse in the format "surah:ayah" or "surah:ayah-ayah"

    Returns null | { ayah?: number; ayahTo?: number; surahOrAyah?: number }

    An object containing the parsed numbers: - surahOrAyah: The surah number - ayah: The first or only ayah number - ayahTo: The ending ayah number (if range specified)

    Throws

    When the input string format is invalid or contains non-numeric values

    Example

    string2NumberSplitterStrict("2:255")    // returns { surahOrAyah: 2, ayah: 255, ayahTo: NaN }
    string2NumberSplitterStrict("2:255-260") // returns { surahOrAyah: 2, ayah: 255, ayahTo: 260 }

Settings

Member Visibility