Interface: IModuleMetadataRepository

Defined in: Data/Repositories/IModuleMetadataRepository.ts:9

Interface for Module Metadata repository Defines all operations for working with the module registry in the main database

Methods

create()

create(entity): ModuleMetadata

Defined in: Data/Repositories/IModuleMetadataRepository.ts:24

Parameters

entity

ModuleMetadata

Returns

ModuleMetadata

---

delete()

delete(id): boolean

Defined in: Data/Repositories/IModuleMetadataRepository.ts:26

Parameters

id

number

Returns

boolean

---

getAll()

getAll(options?): ModuleMetadata[]

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

Parameters

options?

RepositoryQueryOptions

Returns

ModuleMetadata[]

---

getByAbbreviation()

getByAbbreviation(abbreviation): ModuleMetadata | undefined

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

Parameters

abbreviation

string

Returns

ModuleMetadata | undefined

---

getByFeature()

getByFeature(feature): ModuleMetadata[]

Defined in: Data/Repositories/IModuleMetadataRepository.ts:30

Parameters

feature

ModuleFeature

Returns

ModuleMetadata[]

---

getById()

getById(id): ModuleMetadata | undefined

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

Parameters

id

number

Returns

ModuleMetadata | undefined

---

getByLanguage()

getByLanguage(languageCode): ModuleMetadata[]

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

Parameters

languageCode

string

Returns

ModuleMetadata[]

---

getByType()

getByType(moduleType): ModuleMetadata[]

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

Parameters

moduleType

"bible" | "commentary" | "dictionary" | "book" | "devotional" | "lexicon" | "topical_index" | "cross_reference" | "tag_graph"

Returns

ModuleMetadata[]

---

getByUuid()

getByUuid(moduleUuid): ModuleMetadata | undefined

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

Look a module up by its stable module_uuid. Prefer this over getByAbbreviation for identity: abbreviations collide across publishers and change between editions. Returns undefined for pre-2.0 modules, which carry no UUID.

Parameters

moduleUuid

string

Returns

ModuleMetadata | undefined

---

getUnindexedModules()

getUnindexedModules(): ModuleMetadata[]

Defined in: Data/Repositories/IModuleMetadataRepository.ts:22

Returns

ModuleMetadata[]

---

markAsIndexed()

markAsIndexed(moduleId): void

Defined in: Data/Repositories/IModuleMetadataRepository.ts:28

Parameters

moduleId

number

Returns

void

---

search()

search(query): ModuleMetadata[]

Defined in: Data/Repositories/IModuleMetadataRepository.ts:29

Parameters

query

string

Returns

ModuleMetadata[]

---

update()

update(entity): ModuleMetadata

Defined in: Data/Repositories/IModuleMetadataRepository.ts:25

Parameters

entity

ModuleMetadata

Returns

ModuleMetadata