Class: ModuleMetadataRepository
Defined in: Data/Repositories/ModuleMetadataRepository.ts:14
Repository for module metadata entities Provides CRUD operations and queries for installed modules
Implements
Constructors
Constructor
new ModuleMetadataRepository(
sql):ModuleMetadataRepository
Defined in: Data/Repositories/ModuleMetadataRepository.ts:15
Parameters
sql
Returns
ModuleMetadataRepository
Methods
create()
create(
entity):ModuleMetadata
Defined in: Data/Repositories/ModuleMetadataRepository.ts:118
Create a new module
Parameters
entity
Returns
Implementation of
IModuleMetadataRepository.create
delete()
delete(
id):boolean
Defined in: Data/Repositories/ModuleMetadataRepository.ts:188
Delete a module
Parameters
id
number
Returns
boolean
Implementation of
IModuleMetadataRepository.delete
getAll()
getAll(
options?):ModuleMetadata[]
Defined in: Data/Repositories/ModuleMetadataRepository.ts:68
Get all modules
Parameters
options?
Returns
Implementation of
IModuleMetadataRepository.getAll
getByAbbreviation()
getByAbbreviation(
abbreviation):ModuleMetadata|undefined
Defined in: Data/Repositories/ModuleMetadataRepository.ts:56
Get a module by abbreviation
Parameters
abbreviation
string
Returns
ModuleMetadata | undefined
Implementation of
IModuleMetadataRepository.getByAbbreviation
getByFeature()
getByFeature(
feature):ModuleMetadata[]
Defined in: Data/Repositories/ModuleMetadataRepository.ts:226
Get modules by feature
Parameters
feature
Returns
Implementation of
IModuleMetadataRepository.getByFeature
getById()
getById(
id):ModuleMetadata|undefined
Defined in: Data/Repositories/ModuleMetadataRepository.ts:20
Get a module by ID
Parameters
id
number
Returns
ModuleMetadata | undefined
Implementation of
IModuleMetadataRepository.getById
getByLanguage()
getByLanguage(
languageCode):ModuleMetadata[]
Defined in: Data/Repositories/ModuleMetadataRepository.ts:95
Get modules by language
Parameters
languageCode
string
Returns
Implementation of
IModuleMetadataRepository.getByLanguage
getByType()
getByType(
moduleType):ModuleMetadata[]
Defined in: Data/Repositories/ModuleMetadataRepository.ts:83
Get modules by type
Parameters
moduleType
"bible" | "commentary" | "dictionary" | "book" | "devotional" | "lexicon" | "topical_index" | "cross_reference" | "tag_graph"
Returns
Implementation of
IModuleMetadataRepository.getByType
getByUuid()
getByUuid(
moduleUuid):ModuleMetadata|undefined
Defined in: Data/Repositories/ModuleMetadataRepository.ts:38
Get a module by its stable module_uuid.
This is the identity lookup to prefer over getByAbbreviation: an
abbreviation is a display string that two publishers can collide on and
that changes when an edition is renamed, whereas the UUID is fixed for
the life of the module (WS-4). Returns undefined for pre-2.0 modules,
which carry no UUID — callers must fall back to the abbreviation there.
Parameters
moduleUuid
string
Returns
ModuleMetadata | undefined
Implementation of
IModuleMetadataRepository.getByUuid
getUnindexedModules()
getUnindexedModules():
ModuleMetadata[]
Defined in: Data/Repositories/ModuleMetadataRepository.ts:107
Get modules that need indexing
Returns
Implementation of
IModuleMetadataRepository.getUnindexedModules
markAsIndexed()
markAsIndexed(
moduleId):void
Defined in: Data/Repositories/ModuleMetadataRepository.ts:199
Mark a module as indexed
Parameters
moduleId
number
Returns
void
Implementation of
IModuleMetadataRepository.markAsIndexed
search()
search(
query):ModuleMetadata[]
Defined in: Data/Repositories/ModuleMetadataRepository.ts:211
Search modules by name
Parameters
query
string
Returns
Implementation of
IModuleMetadataRepository.search
update()
update(
entity):ModuleMetadata
Defined in: Data/Repositories/ModuleMetadataRepository.ts:151
Update an existing module