@gracious.tech/fetch-client / index

Module: index

Classes

• PassageReference

Interfaces

• PassageReferenceMatch
• PassageArgs

References

BibleClient

Re-exports BibleClient

---

GetPassageOptions

Re-exports GetPassageOptions

---

GetTxtOptions

Re-exports GetTxtOptions

---

IndividualVerse

Re-exports IndividualVerse

---

BibleBook

Re-exports BibleBook

---

BibleBookHtml

Re-exports BibleBookHtml

---

BibleBookTxt

Re-exports BibleBookTxt

---

BibleBookUsfm

Re-exports BibleBookUsfm

---

BibleBookUsx

Re-exports BibleBookUsx

---

BibleClientConfig

Re-exports BibleClientConfig

---

GetLanguagesOptions

Re-exports GetLanguagesOptions

---

GetLanguagesItem

Re-exports GetLanguagesItem

---

GetTranslationsOptions

Re-exports GetTranslationsOptions

---

GetTranslationsItem

Re-exports GetTranslationsItem

---

GetBooksOptions

Re-exports GetBooksOptions

---

GetBooksItem

Re-exports GetBooksItem

---

GetCompletionReturn

Re-exports GetCompletionReturn

---

BibleCollection

Re-exports BibleCollection

---

CrossrefItem

Re-exports CrossrefItem

---

BookCrossref

Re-exports BookCrossref

---

UsageConfig

Re-exports UsageConfig

---

UsageOptions

Re-exports UsageOptions

---

RuntimeLicense

Re-exports RuntimeLicense

---

RuntimeCopyright

Re-exports RuntimeCopyright

---

RuntimeTranslation

Re-exports RuntimeTranslation

---

RuntimeManifest

Re-exports RuntimeManifest

Type Aliases

ReferenceType

Ƭ ReferenceType: "book" | "chapter" | "verse" | "range_verses" | "range_chapters" | "range_multi"

Defined in

references/dist/esm/passage.d.ts:8

Variables

books_ordered

• Const books_ordered: readonly string[]

Defined in

references/dist/esm/data.d.ts:1

---

book_names_english

• Const book_names_english: Readonly<Record<string, string>>

Defined in

references/dist/esm/data.d.ts:2

---

book_abbrev_english

• Const book_abbrev_english: Readonly<Record<string, string>>

Defined in

references/dist/esm/data.d.ts:3

---

english_abbrev_include

• Const english_abbrev_include: readonly [string, string][]

Defined in

references/dist/esm/data.d.ts:4

---

english_abbrev_exclude

• Const english_abbrev_exclude: readonly string[]

Defined in

references/dist/esm/data.d.ts:5

---

last_verse

• Const last_verse: Readonly<Record<string, number[]>>

Defined in

references/dist/esm/last_verse.d.ts:1

Functions

detect_references

▸ detect_references(text, book_names?, exclude_book_names?, min_chars?, match_from_start?): Generator<PassageReferenceMatch, null, undefined>

Parameters

Name	Type
text	string
book_names?	BookNamesArg
exclude_book_names?	string[]
min_chars?	number
match_from_start?	boolean

Returns

Generator<PassageReferenceMatch, null, undefined>

Defined in

references/dist/esm/detect.d.ts:8

---

get_chapters

▸ get_chapters(book): number[]

Parameters

Name	Type
book	string

Returns

number[]

Defined in

references/dist/esm/stats.d.ts:1

---

get_verses

▸ get_verses(book, chapter): number[]

Parameters

Name	Type
book	string
chapter	number

Returns

number[]

Defined in

references/dist/esm/stats.d.ts:2