Skip to main content

Interface: ITopicalIndexRepository

Defined in: Data/Repositories/ITopicalIndexRepository.ts:10

Interface for Topical Index repository Defines all operations for working with topical index databases

Methods​

getAllTopicsPaginated()​

getAllTopicsPaginated(options?): Topic[]

Defined in: Data/Repositories/ITopicalIndexRepository.ts:31

One page of topics, ordered by name.

rootsOnly restricts the page to top-level topics. It applies to plain browsing only: a filtered (FTS) page always spans every level, because a reader who types a subtopic's name is asking for that subtopic. See the implementation for why the top level is the right default for browsing.

Parameters​

options?​
filter?​

string

limit?​

number

offset?​

number

rootsOnly?​

boolean

Returns​

Topic[]

getAllTopicSummaries()​

getAllTopicSummaries(): TopicSummary[]

Defined in: Data/Repositories/ITopicalIndexRepository.ts:64

Returns​

TopicSummary[]

getAllTopicVerseLinks(): TopicVerseLink[]

Defined in: Data/Repositories/ITopicalIndexRepository.ts:65

Returns​

TopicVerseLink[]

getChildCounts()​

getChildCounts(topicIds): ReadonlyMap<number, number>

Defined in: Data/Repositories/ITopicalIndexRepository.ts:42

Direct-child counts for a batch of topics, keyed by topic id.

Batched rather than per-topic because the browse list needs it for every row it draws; topics with no children are absent from the map.

Parameters​

topicIds​

number[]

Returns​

ReadonlyMap<number, number>

getChildren()​

getChildren(parentTopicId): Topic[]

Defined in: Data/Repositories/ITopicalIndexRepository.ts:17

Parameters​

parentTopicId​

number

Returns​

Topic[]

getModuleInfo()​

getModuleInfo(): TopicalIndexModuleInfo | undefined

Defined in: Data/Repositories/ITopicalIndexRepository.ts:12

Returns​

TopicalIndexModuleInfo | undefined

getParentChain()​

getParentChain(topicId): Topic[]

Defined in: Data/Repositories/ITopicalIndexRepository.ts:19

Parameters​

topicId​

number

Returns​

Topic[]

getRecursiveReferenceCount()​

getRecursiveReferenceCount(topicId): number

Defined in: Data/Repositories/ITopicalIndexRepository.ts:57

Parameters​

topicId​

number

Returns​

number

getRecursiveVerseCount()​

getRecursiveVerseCount(topicId): number

Defined in: Data/Repositories/ITopicalIndexRepository.ts:48

Parameters​

topicId​

number

Returns​

number

getRecursiveVersesForTopic()​

getRecursiveVersesForTopic(topicId, options?): TopicVerse[]

Defined in: Data/Repositories/ITopicalIndexRepository.ts:46

Parameters​

topicId​

number

options?​
limit?​

number

offset?​

number

Returns​

TopicVerse[]

getReferenceCount()​

getReferenceCount(topicId): number

Defined in: Data/Repositories/ITopicalIndexRepository.ts:56

Parameters​

topicId​

number

Returns​

number

getRootTopics()​

getRootTopics(): Topic[]

Defined in: Data/Repositories/ITopicalIndexRepository.ts:18

Returns​

Topic[]

getTopic()​

getTopic(topicId): Topic | undefined

Defined in: Data/Repositories/ITopicalIndexRepository.ts:15

Parameters​

topicId​

number

Returns​

Topic | undefined

getTopicCount()​

getTopicCount(filter?, options?): number

Defined in: Data/Repositories/ITopicalIndexRepository.ts:34

Counts what getAllTopicsPaginated pages through, same options.

Parameters​

filter?​

string

options?​
rootsOnly?​

boolean

Returns​

number

getTopicsByName()​

getTopicsByName(name): Topic[]

Defined in: Data/Repositories/ITopicalIndexRepository.ts:21

Parameters​

name​

string

Returns​

Topic[]

getTopicsByVerse()​

getTopicsByVerse(verseId): Topic[]

Defined in: Data/Repositories/ITopicalIndexRepository.ts:16

Parameters​

verseId​

number

Returns​

Topic[]

getVerseCount()​

getVerseCount(topicId): number

Defined in: Data/Repositories/ITopicalIndexRepository.ts:47

Parameters​

topicId​

number

Returns​

number

getVersesForTopic()​

getVersesForTopic(topicId, options?): TopicVerse[]

Defined in: Data/Repositories/ITopicalIndexRepository.ts:45

Parameters​

topicId​

number

options?​
limit?​

number

offset?​

number

Returns​

TopicVerse[]

searchTopics()​

searchTopics(query, options?): Topic[]

Defined in: Data/Repositories/ITopicalIndexRepository.ts:20

Parameters​

query​

string

options?​
limit?​

number

offset?​

number

Returns​

Topic[]