Skip to main content

Interface: IBibleApi

Defined in: Api/IBibleApi.ts:18

Methods​

getAllBooks()​

getAllBooks(): Promise<BookInfo[]>

Defined in: Api/IBibleApi.ts:23

Returns​

Promise<BookInfo[]>

getAvailableBibles()​

getAvailableBibles(): Promise<BibleModuleSummary[]>

Defined in: Api/IBibleApi.ts:20

Returns​

Promise<BibleModuleSummary[]>

getBookName()​

getBookName(bookNumber): Promise<string>

Defined in: Api/IBibleApi.ts:24

Parameters​

bookNumber​

number

Returns​

Promise<string>

getChapter()​

getChapter(abbreviation, bookNumber, chapter): Promise<ChapterResult>

Defined in: Api/IBibleApi.ts:31

Parameters​

abbreviation​

string

bookNumber​

number

chapter​

number

Returns​

Promise<ChapterResult>

getInitialData()​

getInitialData(abbreviation, bookNumber, chapter): Promise<{ availableBibles: BibleModuleSummary[]; bookName: string; bookNumber: number; chapter: number; defaultBible: BibleModuleSummary | null; defaultVerses: FormattedVerse[]; hasInterlinearData?: boolean; }>

Defined in: Api/IBibleApi.ts:45

Load initial data for app startup: available Bibles + default chapter. Reduces round-trips vs calling getAvailableBibles + getChapter separately.

Parameters​

abbreviation​

string

bookNumber​

number

chapter​

number

Returns​

Promise<{ availableBibles: BibleModuleSummary[]; bookName: string; bookNumber: number; chapter: number; defaultBible: BibleModuleSummary | null; defaultVerses: FormattedVerse[]; hasInterlinearData?: boolean; }>

getInterlinearWords()​

getInterlinearWords(abbreviation, verseId): Promise<InterlinearWord[]>

Defined in: Api/IBibleApi.ts:37

Parameters​

abbreviation​

string

verseId​

number

Returns​

Promise<InterlinearWord[]>

getPassage()​

getPassage(abbreviation, startVerseId, endVerseId): Promise<FormattedVerse[]>

Defined in: Api/IBibleApi.ts:30

Get a contiguous passage by start/end verse ID. Simpler than getVerses for sequential ranges.

Parameters​

abbreviation​

string

startVerseId​

number

endVerseId​

number

Returns​

Promise<FormattedVerse[]>

getVerse()​

getVerse(abbreviation, verseId): Promise<FormattedVerse | null>

Defined in: Api/IBibleApi.ts:27

Parameters​

abbreviation​

string

verseId​

number

Returns​

Promise<FormattedVerse | null>

getVerses()​

getVerses(abbreviation, verseIds): Promise<FormattedVerse[]>

Defined in: Api/IBibleApi.ts:28

Parameters​

abbreviation​

string

verseIds​

number[]

Returns​

Promise<FormattedVerse[]>

getVerseTexts()​

getVerseTexts(abbreviation, verseIds): Promise<object[]>

Defined in: Api/IBibleApi.ts:58

Get plain text for multiple verses (used for clipboard, sharing).

Parameters​

abbreviation​

string

verseIds​

number[]

Returns​

Promise<object[]>

hasInterlinearData()​

hasInterlinearData(abbreviation): Promise<boolean>

Defined in: Api/IBibleApi.ts:38

Parameters​

abbreviation​

string

Returns​

Promise<boolean>

search(abbreviation, query, options?): Promise<VerseSearchResult[]>

Defined in: Api/IBibleApi.ts:34

Parameters​

abbreviation​

string

query​

string

options?​

SearchOptions

Returns​

Promise<VerseSearchResult[]>