@swenkerorg/quod-molestias-quo

v1.1.13

Published

13 hours ago

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://scriptu

Downloads

698

0High
0Medium
0Low

swenkertreanpm

toStringTag call-bound consume Object.getPrototypeOf east-asian-width Uint8ClampedArray resolve reuse ECMAScript 6 react-hook-form browser variables deterministic state mime bluebird loading io-ts idle glob tdd limit keys width inspect emit ajv every beanstalk sharedarraybuffer postcss-plugin uninstall once readablestream css variable es8 push scheme-validation ts fast-clone Array Symbol middleware ArrayBuffer.prototype.slice WeakMap ES2019 redact Function.prototype.name hooks auth mixins spinners argparse es jest ratelimit promises names reduce WeakSet deep property elb ECMAScript 7 redux Stream look WebSocket prototype shim ecmascript cloudsearch pipe a11y javascript hasOwn jsdom ECMAScript 2017 getter ES6 entries efficient crypt utility merge watching call mimetypes Observable from directory electron fastify Observables testing Array.prototype.flatMap eslintplugin concat real-time lru classnames flag trim regular expressions colors sns args bundler getopt style RFC-6455 omit warning collection storagegateway slot l10n less mixins logger ES8 symlink Array.prototype.filter random make dir typesafe tap styled-components columns weakset jwt Set package.json up figlet form scheme css nesting mobile hash dependencies batch optimist option watcher -0

Scripture Reference Parser

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 @swenkerorg/quod-molestias-quo

Import and use the package:

import {lookupReference,generateReference} from '@swenkerorg/quod-molestias-quo';

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:

|Verse|Verse ID| |--|--| |Genesis 1:1| 1 | |Genesis 1:2| 2 | |Genesis 1:10| 10 | |Genesis 1:31| 31 | |Genesis 2:1| 32 | |Genesis 50:26| 1533 | |Exodus 1:1| 1534 | |Exodus 1:2| 1535 | |Malachi 4:6| 23145 |

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