BibleKit

Appearance

On this page

Getting Started with BibleKit ​

Overview ​

BibleKit is a versatile tool designed to simplify interaction with Bible API. It is particularly suited for usage with the NestKit Bibles Module, given its unique ID formatting and Bible hierarchy architecture.

Bible Verse IDs ​

In BibleKit, each verse has a specific ID structure. For instance, the verse 'Exo. 1:2' from the KJV Bible would have the ID 'KJV:EXO:1:2'. Here's a breakdown of the ID parts:

  • KJV: Bible Token
  • EXO: Book Token
  • 1: Chapter Number
  • 2: Verse Number

The format 'Exo. 1:2' is called a passage abbreviation. One of the BibleKit's handy features is its ability to convert passage abbreviations to verse IDs and vice versa.

Getting Started ​

WARNING

Before getting started, please ensure you meet the necessary requirements. BibleKit specifically supports a distinct ID format and Bible hierarchy architecture. Hence, we highly recommend using it with the DeepVision Bible Module.

To use BibleKit, first install the @deeepvision/bible-kit package:

bash
npm i @deeepvision/bible-kit --save

Example Usage ​

With BibleKit, you can easily convert passage abbreviations to verse IDs. Use the extractVerseIdsFromPassage function as follows:

ts
import { extractVerseIdsFromPassage } from '@deeepvision/bbile-kit';

const ids = extractVerseIdsFromPassage('KJV', 'Exo. 1:2');

// Output: ids = ["KJV:EXO:1:2"]

This function is capable of handling more complex passages:

ts
import { extractVerseIdsFromPassage } from '@deeepvision/bbile-kit';

const ids = extractVerseIdsFromPassage('KJV', 'Exo. 1:2-4,6');

// Output: ids = ["KJV:EXO:1:2","KJV:EXO:1:3","KJV:EXO:1:4","KJV:EXO:1:6"]

BibleKit boasts of several other useful features designed to simplify your work with Bible APIs. Explore the rest of the documentation to learn more.