Skip to main content

Interface: IDictionaryApi

Defined in: Api/IDictionaryApi.ts:9

Methods

getAllEntries()

getAllEntries(abbreviation, options?): Promise<DictionaryEntryResult[]>

Defined in: Api/IDictionaryApi.ts:17

Parameters

abbreviation

string

options?
limit?

number

offset?

number

Returns

Promise<DictionaryEntryResult[]>


getAvailableDictionaries()

getAvailableDictionaries(): Promise<DictionaryModuleSummary[]>

Defined in: Api/IDictionaryApi.ts:11

Returns

Promise<DictionaryModuleSummary[]>


getDictionaryInfo()

getDictionaryInfo(abbreviation): Promise<DictionaryModuleSummary | null>

Defined in: Api/IDictionaryApi.ts:12

Parameters

abbreviation

string

Returns

Promise<DictionaryModuleSummary | null>


getEntry()

getEntry(abbreviation, entryId): Promise<DictionaryEntryResult | null>

Defined in: Api/IDictionaryApi.ts:15

Parameters

abbreviation

string

entryId

number

Returns

Promise<DictionaryEntryResult | null>


getEntryByKey()

getEntryByKey(abbreviation, key): Promise<DictionaryEntryResult | null>

Defined in: Api/IDictionaryApi.ts:16

Parameters

abbreviation

string

key

string

Returns

Promise<DictionaryEntryResult | null>


getOccurrences()

getOccurrences(abbreviation, strongsNumber, verseRanges?): Promise<object[]>

Defined in: Api/IDictionaryApi.ts:24

Get verses where a Strong's number occurs. Optionally filter to specific passage ranges.

Parameters

abbreviation

string

strongsNumber

string

verseRanges?

PassageRange[]

Returns

Promise<object[]>


getOccurrencesForVerse()

getOccurrencesForVerse(abbreviation, verseId): Promise<object[]>

Defined in: Api/IDictionaryApi.ts:30

Parameters

abbreviation

string

verseId

number

Returns

Promise<object[]>


searchEntries()

searchEntries(abbreviation, query, limit?): Promise<DictionaryEntryResult[]>

Defined in: Api/IDictionaryApi.ts:20

Parameters

abbreviation

string

query

string

limit?

number

Returns

Promise<DictionaryEntryResult[]>