Function formatScrRef

  • formatScrRef(
        scrRef: ScriptureReference,
        optionOrLocalizedBookName?: string,
        chapterVerseSeparator?: string,
        bookChapterSeparator?: string,
    ): string

    Formats a Scripture reference.

    Parameters

    • scrRef: ScriptureReference

      The Scripture reference to format.

    • OptionaloptionOrLocalizedBookName: string

      Either 'id' (the default) to format using the "standard" (as defined by SIL/UBS) 3-letter book ID, 'English' to format using the English book name spelled out, or some other string (e.g., a localized book name, vernacular abbreviation, FCBH book id, etc.) to use.

    • OptionalchapterVerseSeparator: string

      The character used to separate the chapter number from the verse number. Default is a colon (:). Note: More than one character is allowed.

    • OptionalbookChapterSeparator: string

      The character used to separate the book from the chapter number. Default is a single space. Note: More than one character is allowed.

    Returns string

    The formatted reference.

Settings

Member Visibility