Skip to main content

Interface: IUserCommentaryRepository

Defined in: Data/Repositories/IUserCommentaryRepository.ts:7

Repository interface for user commentary collections

Extends​

Methods​

countNotes()​

countNotes(commentaryId): number

Defined in: Data/Repositories/IUserCommentaryRepository.ts:27

Count notes in a commentary collection

Parameters​

commentaryId​

number

Returns​

number

create()​

create(entity): UserCommentary

Defined in: Data/Core/IRepository.ts:36

Create a new entity

Parameters​

entity​

UserCommentary

Entity to create

Returns​

UserCommentary

The created entity with ID populated

Inherited from​

IRepository.create

delete()​

delete(id): boolean

Defined in: Data/Core/IRepository.ts:50

Delete an entity by ID

Parameters​

id​

number

Primary key of the entity to delete

Returns​

boolean

True if deleted, false if not found

Inherited from​

IRepository.delete

getAll()​

getAll(options?): UserCommentary[]

Defined in: Data/Core/IRepository.ts:57

Get all entities

Parameters​

options?​

RepositoryQueryOptions

Optional query options (limit, offset, ordering)

Returns​

UserCommentary[]

Array of all entities

Inherited from​

IRepository.getAll

getById()​

getById(id): UserCommentary | undefined

Defined in: Data/Core/IRepository.ts:29

Retrieve an entity by its ID

Parameters​

id​

number

Primary key of the entity

Returns​

UserCommentary | undefined

The entity, or undefined if not found

Inherited from​

IRepository.getById

getByType()​

getByType(type): UserCommentary[]

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

Get all commentary collections by type (based on metadata or usage) This can be used to filter prayer lists vs verse commentary collections

Parameters​

type​

string

Returns​

UserCommentary[]

getDefault()​

getDefault(): UserCommentary | undefined

Defined in: Data/Repositories/IUserCommentaryRepository.ts:11

Get the default commentary collection

Returns​

UserCommentary | undefined

setDefault()​

setDefault(id): boolean

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

Set a commentary as the default

Parameters​

id​

number

Returns​

boolean

update()​

update(entity): UserCommentary

Defined in: Data/Core/IRepository.ts:43

Update an existing entity

Parameters​

entity​

UserCommentary

Entity with updated values

Returns​

UserCommentary

The updated entity

Inherited from​

IRepository.update