@joewalker/scripture-ref 0.4.0

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+export { Verse, ACCURACY } from './passage/verse.js';
+export type { Accuracy, VerseParseResult } from './passage/verse.js';
+export { VerseRange } from './passage/verse-range.js';
+export { Passage } from './passage/passage.js';
+export { PassageTally } from './passage/passage-tally.js';
+export { getPassageText, search } from './book/books.js';
+export type { Book } from './book/books.js';
+export { findBookNumber, getShortName, getLongName, chaptersInBook, versesInChapter, versesInBible, chaptersInBible, booksInBible, verseOrdinal, decodeOrdinal, bookNames, shortBookNames, } from './passage/bible-info.js';

package/dist/index.js

@@ -0,0 +1,7 @@
+export { Verse, ACCURACY } from './passage/verse.js';
+export { VerseRange } from './passage/verse-range.js';
+export { Passage } from './passage/passage.js';
+export { PassageTally } from './passage/passage-tally.js';
+export { getPassageText, search } from './book/books.js';
+export { findBookNumber, getShortName, getLongName, chaptersInBook, versesInChapter, versesInBible, chaptersInBible, booksInBible, verseOrdinal, decodeOrdinal, bookNames, shortBookNames, } from './passage/bible-info.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAErD,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAGzD,OAAO,EACL,cAAc,EACd,YAAY,EACZ,WAAW,EACX,cAAc,EACd,eAAe,EACf,aAAa,EACb,eAAe,EACf,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,SAAS,EACT,cAAc,GACf,MAAM,yBAAyB,CAAC"}

package/dist/passage/bible-info.d.ts

@@ -0,0 +1,64 @@
+/**
+ * Find the (1-based) book number for a given string.
+ * e.g.:
+ * - findBookNumber('genesis') === 1
+ * - findBookNumber('gen') === 1
+ * - findBookNumber('g') === undefined
+ */
+export declare function findBookNumber(name: string): number | undefined;
+/**
+ * What is the canonical short name for a book?
+ */
+export declare function getShortName(book: number): string;
+/**
+ * What is the canonical long name for a book?
+ */
+export declare function getLongName(book: number): string;
+/**
+ * How many chapters are there in the given book?
+ */
+export declare function chaptersInBook(book: number): number;
+/**
+ * How many verses are there in the given chapter?
+ */
+export declare function versesInChapter(book: number, chapter: number): number;
+/**
+ * How many verses are there in the Bible? Somewhat for completeness
+ */
+export declare function versesInBible(): number;
+/**
+ * How many chapters are there in the Bible? Somewhat for completeness
+ */
+export declare function chaptersInBible(): number;
+/**
+ * How many books are there in the Bible? Somewhat for completeness
+ */
+export declare function booksInBible(): number;
+/**
+ * Accessor for the full list of names of the books of the Bible.
+ */
+export declare function bookNames(): ReadonlyArray<string>;
+/**
+ * Accessor for the full list of names of the books of the Bible.
+ */
+export declare function shortBookNames(): ReadonlyArray<string>;
+/**
+ * Where does this verse come in the Bible? Starting with Gen 1:1 as
+ * number 1 counting up one per verse and not resetting at each new
+ * chapter.
+ * @see decodeOrdinal()
+ * @param book The book part of the reference.
+ * @param chapter The current chapter
+ * @param verse The current verse
+ * @returns The ordinal number of the referenced verse
+ */
+export declare function verseOrdinal(book: number, chapter: number, verse: number): number;
+/**
+ * Where does this verse come in the Bible? Starting with Gen 1:1 as
+ * number 1 counting up one per verse and not resetting at each new
+ * chapter.
+ * @see verseOrdinal()
+ * @param ordinal The ordinal number of the verse
+ * @returns A 3 tuple; book, chapter, verse
+ */
+export declare function decodeOrdinal(ordinal: number): [number, number, number];