Function string2NumberSplitter

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

    Splits a string containing surah and ayah numbers into their numeric components.

    Parameters

    • str: string

      Input string containing numbers separated by non-digits (e.g., "2:255" or "2 255" or "2-255")

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

    An object containing the parsed numbers, or null if parsing fails - ayah: The ayah number if present - ayahTo: The ending ayah number if a range is specified - surahOrAyah: The surah number

    Example

    stringNumberSplitter("2:255") // returns { ayah: 255, ayahTo: 0, surahOrAyah: 2 }
    stringNumberSplitter("2:255-260") // returns { ayah: 255, ayahTo: 260, surahOrAyah: 2 }
    stringNumberSplitter("invalid") // returns null

Settings

Member Visibility