Skip to main content

Interface: ICommentaryApi

Defined in: Extensions/ExtensionApiTypes.ts:206

Properties​

onDidChangeActiveCommentary​

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

Defined in: Extensions/ExtensionApiTypes.ts:228

Methods​

getEntriesForRange()​

getEntriesForRange(moduleId, startVerseId, endVerseId): Promise<CommentaryEntryDto[]>

Defined in: Extensions/ExtensionApiTypes.ts:214

Get all entries that touch a verse range. Useful for "show all commentary on Romans 8" or for building an index.

Parameters​

moduleId​

string

startVerseId​

number

endVerseId​

number

Returns​

Promise<CommentaryEntryDto[]>

getEntry()​

getEntry(moduleId, verseId): Promise<CommentaryEntryDto | null>

Defined in: Extensions/ExtensionApiTypes.ts:208

Parameters​

moduleId​

string

verseId​

number

Returns​

Promise<CommentaryEntryDto | null>

iterateEntries()​

iterateEntries(opts): Promise<CommentaryIterationResult>

Defined in: Extensions/ExtensionApiTypes.ts:221

Cursor-based iteration over all entries in a module.

Parameters​

opts​

IterateCommentaryOpts

Returns​

Promise<CommentaryIterationResult>

listModules()​

listModules(): Promise<CommentaryModuleInfoDto[]>

Defined in: Extensions/ExtensionApiTypes.ts:207

Returns​

Promise<CommentaryModuleInfoDto[]>

registerProvider()​

registerProvider(provider): Promise<DisposableHandle>

Defined in: Extensions/ExtensionApiTypes.ts:224

Register a custom commentary provider. The host treats it as another module.

Parameters​

provider​

CommentaryProviderDescriptor

Returns​

Promise<DisposableHandle>