Class BiblesService

Constructors

constructor

new BiblesService(
    loggerFactory: WinstonLoggerFactory,
    bibleRepository: Repository<Bible>,
    bibleBookRepository: Repository<BibleBook>,
    bibleVerseRepository: Repository<BibleVerse>,
    bibleStoryRepository: Repository<BibleStory>,
): BiblesService
Parameters
- loggerFactory: WinstonLoggerFactory
- bibleRepository: Repository<Bible>
- bibleBookRepository: Repository<BibleBook>
- bibleVerseRepository: Repository<BibleVerse>
- bibleStoryRepository: Repository<BibleStory>
Returns BiblesService
- Defined in libs/core/src/modules/bibles/bibles.service.ts:45

Methods

`Protected`applyFilterToQuery

applyFilterToQuery(
    query: SelectQueryBuilder<Bible>,
    alias: string,
    filter: BiblesFilter,
): void
Parameters
- query: SelectQueryBuilder<Bible>
- alias: string
- filter: BiblesFilter
Returns void
- Defined in libs/core/src/modules/bibles/bibles.service.ts:125

`Protected`applyOrderByToQuery

applyOrderByToQuery(
    query: SelectQueryBuilder<Bible>,
    alias: string,
    orderBy: BiblesOrderBy,
): void
Parameters
- query: SelectQueryBuilder<Bible>
- alias: string
- orderBy: BiblesOrderBy
Returns void
- Defined in libs/core/src/modules/bibles/bibles.service.ts:137

decodeBookId

decodeBookId(
id: string,
ctx: BaseServiceMethodContext,
): { bible: string; book: string }
Decode book id and return bible and book ids
Parameters
- id: string
  book id in format "BIBLE:BOOK"
- ctx: BaseServiceMethodContext
Returns { bible: string; book: string }
- bible and book ids
- Defined in libs/core/src/modules/bibles/bibles.service.ts:485

decodeChapterId

decodeChapterId(
id: string,
ctx: BaseServiceMethodContext,
): { bible: string; book: string; chapter: string }
Decode chapter id and return bible, book and chapter ids
Parameters
- id: string
  chapter id in format "BIBLE:BOOK:CHAPTER"
- ctx: BaseServiceMethodContext
Returns { bible: string; book: string; chapter: string }
- bible, book and chapter id
- Defined in libs/core/src/modules/bibles/bibles.service.ts:513

decodePassage

decodePassage(
__namedParameters: DecodePassageOptions,
ctx: BaseServiceMethodContext,
): Promise<DecodedBiblePassage>
Decode passage and return bible verses
Parameters
- __namedParameters: DecodePassageOptions
- ctx: BaseServiceMethodContext
Returns Promise<DecodedBiblePassage>
Example
```
await this.bibleService.decodePassage({
 bibleId: 'KJV',
 passage: '1Jn 1:1-3'
})
```
- Defined in libs/core/src/modules/bibles/bibles.service.ts:353

getBook

getBook(id: string): Promise<MaybeNull<BibleBook>>
Get bible book by id
Parameters
- id: string
  bible book id in format "BIBLE:BOOK"
Returns Promise<MaybeNull<BibleBook>>
- bible book
- Defined in libs/core/src/modules/bibles/bibles.service.ts:167

getBookOrFail

getBookOrFail(id: string, ctx: BaseServiceMethodContext): Promise<BibleBook>
Parameters
- id: string
- ctx: BaseServiceMethodContext
Returns Promise<BibleBook>
- Defined in libs/core/src/modules/bibles/bibles.service.ts:173

getBooks

getBooks(bibleId: string): Promise<BibleBook[]>
Fetch bibles list
Parameters
- bibleId: string
  bible id in format "BIBLE" (e.g. "KJV")
Returns Promise<BibleBook[]>
- bibles books list
- Defined in libs/core/src/modules/bibles/bibles.service.ts:151

getChapter

getChapter(id: string, ctx: BaseServiceMethodContext): Promise<BibleChapter>
Get bible book chapter by id
Parameters
- id: string
  chapter id in format "BIBLE:BOOK:CHAPTER"
- ctx: BaseServiceMethodContext
Returns Promise<BibleChapter>
- bible chapter
- Defined in libs/core/src/modules/bibles/bibles.service.ts:223

getChapters

getChapters(bibleBookId: string): Promise<BibleChapter[]>
Get bible book chapters list
Parameters
- bibleBookId: string
  bible book id in format "BIBLE:BOOK"
Returns Promise<BibleChapter[]>
- bible chapters
- Defined in libs/core/src/modules/bibles/bibles.service.ts:196

getMany

getMany(__namedParameters: FetchBiblesOptions): Promise<[Bible[], ListMeta]>
Get bibles list.
Parameters
- __namedParameters: FetchBiblesOptions
Returns Promise<[Bible[], ListMeta]>
- Defined in libs/core/src/modules/bibles/bibles.service.ts:97

getOne

getOne(id: string): Promise<MaybeNull<Bible>>
Parameters
- id: string
Returns Promise<MaybeNull<Bible>>
- Defined in libs/core/src/modules/bibles/bibles.service.ts:57

getOneBy

getOneBy(opts: GetBibleByOptions): Promise<MaybeNull<Bible>>
Parameters
- opts: GetBibleByOptions
Returns Promise<MaybeNull<Bible>>
- Defined in libs/core/src/modules/bibles/bibles.service.ts:63

getOneByOrFail

getOneByOrFail(
opts: GetBibleByOptions,
ctx: BaseServiceMethodContext,
): Promise<Bible>
Parameters
- opts: GetBibleByOptions
- ctx: BaseServiceMethodContext
Returns Promise<Bible>
- Defined in libs/core/src/modules/bibles/bibles.service.ts:67

getOneOrFail

getOneOrFail(id: string, ctx: BaseServiceMethodContext): Promise<Bible>
Fetch bible by id or fail
Parameters
- id: string
- ctx: BaseServiceMethodContext
Returns Promise<Bible>
- Defined in libs/core/src/modules/bibles/bibles.service.ts:88

getStories

getStories(opts: GetBibleStoriesOptions): Promise<BibleStory[]>
Fetch bible stories list Stories helps to group verses together
Parameters
- opts: GetBibleStoriesOptions
Returns Promise<BibleStory[]>
- Defined in libs/core/src/modules/bibles/bibles.service.ts:333

getVerse

getVerse(id: string): Promise<null | BibleVerse>
Get bible verse by id
Parameters
- id: string
  verse id in format "BIBLE:BOOK:CHAPTER:VERSE"
Returns Promise<null | BibleVerse>
- bible verse
- Defined in libs/core/src/modules/bibles/bibles.service.ts:262

getVerseByPassage

getVerseByPassage(
opts: GetVerseByPassageOptions,
ctx: BaseServiceMethodContext,
): Promise<BibleVerse>
Get bible verse by passage in format "BOOK_ABBREVATION CHAPTER:VERSE"
Parameters
- opts: GetVerseByPassageOptions
- ctx: BaseServiceMethodContext
Returns Promise<BibleVerse>
- bible verse
- Defined in libs/core/src/modules/bibles/bibles.service.ts:272

getVerseOrFail

getVerseOrFail(id: string, ctx: BaseServiceMethodContext): Promise<BibleVerse>
Parameters
- id: string
- ctx: BaseServiceMethodContext
Returns Promise<BibleVerse>
- Defined in libs/core/src/modules/bibles/bibles.service.ts:296

getVerses

getVerses(opts: GetBibleVersesOptions): Promise<BibleVerse[]>
Fetch verses list
Parameters
- opts: GetBibleVersesOptions
Returns Promise<BibleVerse[]>
- Defined in libs/core/src/modules/bibles/bibles.service.ts:317

Class BiblesService

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns BiblesService

Methods

ProtectedapplyFilterToQuery

Parameters

Returns void

ProtectedapplyOrderByToQuery

Parameters

Returns void

decodeBookId

Parameters

Returns { bible: string; book: string }

decodeChapterId

Parameters

Returns { bible: string; book: string; chapter: string }

decodePassage

Parameters

Returns Promise<DecodedBiblePassage>

Example

getBook

Parameters

Returns Promise<MaybeNull<BibleBook>>

getBookOrFail

Parameters

Returns Promise<BibleBook>

getBooks

Parameters

Returns Promise<BibleBook[]>

getChapter

Parameters

Returns Promise<BibleChapter>

getChapters

Parameters

Returns Promise<BibleChapter[]>

getMany

Parameters

Returns Promise<[Bible[], ListMeta]>

getOne

Parameters

Returns Promise<MaybeNull<Bible>>

getOneBy

Parameters

Returns Promise<MaybeNull<Bible>>

getOneByOrFail

Parameters

Returns Promise<Bible>

getOneOrFail

Parameters

Returns Promise<Bible>

getStories

Parameters

Returns Promise<BibleStory[]>

getVerse

Parameters

Returns Promise<null | BibleVerse>

getVerseByPassage

Parameters

Returns Promise<BibleVerse>

getVerseOrFail

Parameters

Returns Promise<BibleVerse>

getVerses

Parameters

Returns Promise<BibleVerse[]>

Settings

On This Page

`Protected`applyFilterToQuery

`Protected`applyOrderByToQuery