Class BiblesService

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

logger

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

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

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'
  })
  Copy

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

getBookOrFail

• getBookOrFail(id: string, ctx: BaseServiceMethodContext): Promise<BibleBook>

  Parameters

  • id: string
  • ctx: BaseServiceMethodContext

  Returns Promise<BibleBook>

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

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

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

getMany

• getMany(__namedParameters: FetchBiblesOptions): Promise<[Bible[], ListMeta]>

  Get bibles list.

  Parameters

  • __namedParameters: FetchBiblesOptions

  Returns Promise<[Bible[], ListMeta]>

getOne

• getOne(id: string): Promise<MaybeNull<Bible>>

  Parameters

  • id: string

  Returns Promise<MaybeNull<Bible>>

getOneBy

• getOneBy(opts: GetBibleByOptions): Promise<MaybeNull<Bible>>

  Parameters

  • opts: GetBibleByOptions

  Returns Promise<MaybeNull<Bible>>

getOneByOrFail

• getOneByOrFail(
      opts: GetBibleByOptions,
      ctx: BaseServiceMethodContext,
  ): Promise<Bible>

  Parameters

  • opts: GetBibleByOptions
  • ctx: BaseServiceMethodContext

  Returns Promise<Bible>

getOneOrFail

• getOneOrFail(id: string, ctx: BaseServiceMethodContext): Promise<Bible>

  Fetch bible by id or fail

  Parameters

  • id: string
  • ctx: BaseServiceMethodContext

  Returns Promise<Bible>

getStories

• getStories(opts: GetBibleStoriesOptions): Promise<BibleStory[]>

  Fetch bible stories list Stories helps to group verses together

  Parameters

  • opts: GetBibleStoriesOptions

  Returns Promise<BibleStory[]>

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

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

getVerseOrFail

• getVerseOrFail(id: string, ctx: BaseServiceMethodContext): Promise<BibleVerse>

  Parameters

  • id: string
  • ctx: BaseServiceMethodContext

  Returns Promise<BibleVerse>

getVerses

• getVerses(opts: GetBibleVersesOptions): Promise<BibleVerse[]>

  Fetch verses list

  Parameters

  • opts: GetBibleVersesOptions

  Returns Promise<BibleVerse[]>