Skip to main content

Interface: ICommentaryApi

Defined in: Api/ICommentaryApi.ts:14

Methods​

batchRestoreSession()​

batchRestoreSession(requests): Promise<Record<string, CommentaryEntryResult[]>>

Defined in: Api/ICommentaryApi.ts:35

Batch-load entries for multiple tabs/verses at once (session restore).

Parameters​

requests​

object[]

Returns​

Promise<Record<string, CommentaryEntryResult[]>>

getAllEntrySummaries()​

getAllEntrySummaries(abbreviation): Promise<CommentaryEntrySummaryResult[]>

Defined in: Api/ICommentaryApi.ts:22

Parameters​

abbreviation​

string

Returns​

Promise<CommentaryEntrySummaryResult[]>

getAvailableCommentaries()​

getAvailableCommentaries(): Promise<CommentaryModuleSummary[]>

Defined in: Api/ICommentaryApi.ts:16

Returns​

Promise<CommentaryModuleSummary[]>

getCommentaryInfo()​

getCommentaryInfo(abbreviation): Promise<CommentaryModuleSummary | null>

Defined in: Api/ICommentaryApi.ts:17

Parameters​

abbreviation​

string

Returns​

Promise<CommentaryModuleSummary | null>

getEntriesForVerse()​

getEntriesForVerse(abbreviation, verseId): Promise<CommentaryEntryResult[]>

Defined in: Api/ICommentaryApi.ts:20

Parameters​

abbreviation​

string

verseId​

number

Returns​

Promise<CommentaryEntryResult[]>

getNextVerseWithContent()​

getNextVerseWithContent(abbreviation, verseId): Promise<number | null>

Defined in: Api/ICommentaryApi.ts:25

Parameters​

abbreviation​

string

verseId​

number

Returns​

Promise<number | null>

getPreviousVerseWithContent()​

getPreviousVerseWithContent(abbreviation, verseId): Promise<number | null>

Defined in: Api/ICommentaryApi.ts:26

Parameters​

abbreviation​

string

verseId​

number

Returns​

Promise<number | null>

hasContentForVerse()​

hasContentForVerse(abbreviation, verseId): Promise<boolean>

Defined in: Api/ICommentaryApi.ts:21

Parameters​

abbreviation​

string

verseId​

number

Returns​

Promise<boolean>

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

Defined in: Api/ICommentaryApi.ts:29

Parameters​

abbreviation​

string

query​

string

limit?​

number

Returns​

Promise<VerseSearchResult[]>