Skip to main content

Interface: IDictionaryApi

Defined in: Extensions/ExtensionApiTypes.ts:233

Properties​

onDidChangeActiveDictionary​

onDidChangeActiveDictionary: IEventApi<{ moduleId: string; } | null>

Defined in: Extensions/ExtensionApiTypes.ts:257

Methods​

iterateEntries()​

iterateEntries(opts): Promise<DictionaryIterationResult>

Defined in: Extensions/ExtensionApiTypes.ts:247

Cursor-based iteration over all entries.

Parameters​

opts​

IterateDictionaryOpts

Returns​

Promise<DictionaryIterationResult>

listModules()​

listModules(): Promise<DictionaryModuleInfoDto[]>

Defined in: Extensions/ExtensionApiTypes.ts:234

Returns​

Promise<DictionaryModuleInfoDto[]>

lookup()​

lookup(moduleId, key): Promise<DictionaryEntryDto | null>

Defined in: Extensions/ExtensionApiTypes.ts:237

Look up a single entry by its key (Strong's number, lemma, or headword).

Parameters​

moduleId​

string

key​

string

Returns​

Promise<DictionaryEntryDto | null>

registerProvider()​

registerProvider(provider): Promise<DisposableHandle>

Defined in: Extensions/ExtensionApiTypes.ts:253

Register a custom dictionary provider — e.g. a paid lexicon, an online API, or a richer Greek/Hebrew lookup with stemming and morphology data.

Parameters​

provider​

DictionaryProviderDescriptor

Returns​

Promise<DisposableHandle>

search(moduleId, query, opts?): Promise<DictionaryEntryDto[]>

Defined in: Extensions/ExtensionApiTypes.ts:240

Free-text search.

Parameters​

moduleId​

string

query​

string

opts?​
limit?​

number

Returns​

Promise<DictionaryEntryDto[]>