Skip to main content

Class: VerseIdHelper

Defined in: Data/Core/Types.ts:496

Helper class for verse ID calculations

Constructors​

Constructor​

new VerseIdHelper(): VerseIdHelper

Returns​

VerseIdHelper

Methods​

calculate()​

static calculate(book, chapter, verse): number

Defined in: Data/Core/Types.ts:510

Calculate verse ID from components Format: (book_number * 1000000) + (chapter * 1000) + verse

Parameters​

book​

number

chapter​

number

verse​

number

Returns​

number

Example​

// Using book number
const id1 = VerseIdHelper.calculate(43, 3, 16); // John 3:16

// Using Book enum
const id2 = VerseIdHelper.calculate(Book.John, 3, 16); // John 3:16

format()​

static format(verseId): string

Defined in: Data/Core/Types.ts:530

Format verse ID as a human-readable string (requires book name lookup)

Parameters​

verseId​

number

Returns​

string

formatReference()​

static formatReference(startVerseId, endVerseId, bookNames): string

Defined in: Data/Core/Types.ts:596

Format a verse range as a human-readable reference string. Accepts a book name lookup function or Map to resolve book numbers to names.

Parameters​

startVerseId​

number

endVerseId​

number

bookNames​

Map<number, string> | ((bookNum) => string)

Returns​

string

Example​

const bookNames = new Map([[43, 'John'], [45, 'Romans']]);
VerseIdHelper.formatReference(43003016, 43003016, bookNames); // "John 3:16"
VerseIdHelper.formatReference(43003016, 43003018, bookNames); // "John 3:16-18"
VerseIdHelper.formatReference(43003016, 43004005, bookNames); // "John 3:16 - 4:5"

getBookEnum()​

static getBookEnum(bookNumber): Book | undefined

Defined in: Data/Core/Types.ts:577

Get Book enum from book number

Parameters​

bookNumber​

number

Returns​

Book | undefined

getBookName()​

static getBookName(book): string

Defined in: Data/Core/Types.ts:570

Get book name from Book enum value

Parameters​

book​

Book

Returns​

string

getChapterRange()​

static getChapterRange(book, chapter): VerseRange

Defined in: Data/Core/Types.ts:560

Get verse range from start to end chapter

Parameters​

book​

number

chapter​

number

Returns​

VerseRange

Example​

// Using book number
const range1 = VerseIdHelper.getChapterRange(43, 3); // John 3

// Using Book enum
const range2 = VerseIdHelper.getChapterRange(Book.John, 3); // John 3

isValid()​

static isValid(verseId): boolean

Defined in: Data/Core/Types.ts:538

Check if a verse ID is valid

Parameters​

verseId​

number

Returns​

boolean

parse()​

static parse(verseId): VerseReference

Defined in: Data/Core/Types.ts:518

Parse verse ID into components

Parameters​

verseId​

number

Returns​

VerseReference