awoken-bible-reference
Version:
Bible verse reference parser, generator and manipulator
22 lines (21 loc) • 901 B
TypeScript
/**
* Contains various utility functions related to converting BibleVerse's to and
* from "Verse Indexes" (IE: VIDX)
*/
import { Versification } from './Versification';
import { BibleRef, BibleVerse } from './BibleRef';
/**
* Converts a BibleVerse to a "Verse Index" which would be the 0-based index of
* the verse in an array contain all verse of the bible
*/
export declare function toVidx(versification: Versification, verse: BibleVerse): number;
export declare function fromVidx(versification: Versification, vidx: number): BibleVerse;
/**
* Counts the total number of verses expressed by a BibleRef
*/
export declare function countVerses(v: Versification, ref: BibleRef): number;
/**
* Takes a list of BibleRefs and returns a new list containing just the first N
* verses from the set
*/
export declare function firstNVerses(v: Versification, refs: BibleRef[], n: number): BibleRef[];