Class: CommentaryEntry

Defined in: Data/Models/Commentary/CommentaryEntry.ts:15

Commentary entry entity from a commentary module database

Constructors

Constructor

new CommentaryEntry(data): CommentaryEntry

Defined in: Data/Models/Commentary/CommentaryEntry.ts:25

Parameters

data

content

string

contentFile?

string

entryId?

number

entryLevel

"book" | "verse" | "passage" | "chapter"

metadata?

Metadata

verseIdEnd?

number

verseIdStart?

number

wordCount?

number

Returns

CommentaryEntry

Properties

content

content: string

Defined in: Data/Models/Commentary/CommentaryEntry.ts:20

---

contentFile?

optional contentFile?: string

Defined in: Data/Models/Commentary/CommentaryEntry.ts:21

---

entryId?

optional entryId?: number

Defined in: Data/Models/Commentary/CommentaryEntry.ts:16

---

entryLevel

entryLevel: "book" | "verse" | "passage" | "chapter"

Defined in: Data/Models/Commentary/CommentaryEntry.ts:19

---

metadata?

optional metadata?: Metadata

Defined in: Data/Models/Commentary/CommentaryEntry.ts:23

---

verseIdEnd?

optional verseIdEnd?: number

Defined in: Data/Models/Commentary/CommentaryEntry.ts:18

---

verseIdStart?

optional verseIdStart?: number

Defined in: Data/Models/Commentary/CommentaryEntry.ts:17

---

wordCount?

optional wordCount?: number

Defined in: Data/Models/Commentary/CommentaryEntry.ts:22

Methods

getExcerpt()

getExcerpt(maxLength?): string

Defined in: Data/Models/Commentary/CommentaryEntry.ts:76

Get an excerpt of the content

Parameters

maxLength?

number = 200

Returns

string

---

isBookLevel()

isBookLevel(): boolean

Defined in: Data/Models/Commentary/CommentaryEntry.ts:48

Check if this is a book-level entry

Returns

boolean

---

isChapterLevel()

isChapterLevel(): boolean

Defined in: Data/Models/Commentary/CommentaryEntry.ts:55

Check if this is a chapter-level entry

Returns

boolean

---

isVerseLevel()

isVerseLevel(): boolean

Defined in: Data/Models/Commentary/CommentaryEntry.ts:62

Check if this is a verse-level entry

Returns

boolean

---

isVerseRange()

isVerseRange(): boolean

Defined in: Data/Models/Commentary/CommentaryEntry.ts:69

Check if this entry covers a verse range

Returns

boolean