scripture-guide v1.0.55

Scripture Reference Parser

This universal scripture reference parser is designed to lookup any reference to a scriptural text and return the corresponding verse ids. These verse ids can then be used to query a database using a verse id index, such as those found on https://scriptures.nephi.org/

Scripture Reference Conventions

Scripture references generally follow standard conventions for citing the Bible. Various style guides have different conventions for citing the bible, but they are all generally recgoniziable by the elements of Book, Chapter, and Verse. Multiple reference types exist for citing various combinations of book, verse, or chapter ranges, discreet passages, and non-sequential verses within a single chapter or book, or across multiple chapters and/or books.

Prerequisites

• This scripture reference parser executes in a JavaScript envrionment. (Both NodeJS and major browsers supported)

Installing

Install the package:

npm i scripture-guide

Import and use the package:

import {lookupReference,generateReference} from 'scripture-guide';

const verses = lookupReference('Jn 3:16');
console.log(verses);
// { query: 'Jn 3:16', ref: 'John 3:16', verse_ids: [ 26137 ] }
//  John 3:16 is the 26137th verse in the Bible

const ref = generateReference([ 26137, 26138, 26139 ]);
console.log(ref);
// John 3:16-18

INPUT—Supported Reference Types

Example

A scripture reference string is passed into the scripture object’s lookupReference() function like this:

let results = scripture.lookupReference('Ex 20.5,10');

OUTPUT—Verse IDs

The function will return a json object containing the following:

• query: the user-provided input string (what was said)
• ref: the parsed, interpreted reference string (what was meant)
• verse_ids: the resuluting array containing the verse ID integers corresponding to the input query

{
    "query": "Ex 20.5,10",
    "ref": "Exodus 20:5, 10",
    "verse_ids": [ 2057, 2062 ]
}

Using Verse IDs

• Verse IDs are intended to be used to query a scripture database. (Database not included).
• Verse IDs are calculated as a function of number of verses away from Genesis 1:1, inclusive, using the conventionally standard sequence of books, chapters, and verses.

Example Verse IDs:

See also: Master Verse ID list

Example Database Usage:

Assuming a verse_id–index database table named scripture_verses exists

SELECT * FROM `scripture_verses` WHERE verse_id IN (2057, 2062);

This query will enable the retrieval of the text associated with the input reference, mediated by verse IDs.

Customizing Verse IDs

• The data/scriptdata.json file contains the sequential index from which verse_ids are calculated.
• If needed, this file may be edited to correspond to a difference database index
• The data structure is:

{
    "Book 1 Name": 
        [
            "verse count (int) of chapter 1",
            "verse count (int) of chapter 2",
            "verse count (int) of chapter 3",
            "verse count (int) of chapter 4"
        ],
    "Book 2 Name": 
        [
            "verse count (int) of chapter 1",
            "verse count (int) of chapter 2",
            "verse count (int) of chapter 3"
        ],
}

Following this structure, the verse_ids corresponding to each book, chapter and verse may be modified according to the desired sequenital index.

Authors

• KC Kern - Initial work - kckern

npm run build && node test.js