Skip to content

@gracious.tech/fetch-client


@gracious.tech/fetch-client / book/bible / BibleBookTxt

Class: BibleBookTxt

Defined in: client/src/book/bible.ts:361

Access to the plain text of a Bible book (will be Markdown if headings/notes enabled)

Methods

get_attribution()

get_attribution(license?): string

Defined in: client/src/book/bible.ts:375

Get appropriate text for attribution (defaults to first license, optionally provide one)

Parameters

license?

RuntimeLicense

Returns

string


get_whole()

get_whole(options?): string

Defined in: client/src/book/bible.ts:396

Get the contents of entire book

Parameters

options?

GetTxtOptions = {}

Returns

string


get_passage()

get_passage(start_chapter, start_verse, end_chapter, end_verse, options?): string

Defined in: client/src/book/bible.ts:401

Get txt for a specific passage

Parameters

start_chapter

number

start_verse

number

end_chapter

number

end_verse

number

options?

GetTxtOptions = {}

Returns

string


get_passage_from_ref()

get_passage_from_ref(ref, options?): string

Defined in: client/src/book/bible.ts:454

Get txt for a specific passage specified by a PassageReference object

Parameters

ref

PassageReference

options?

GetTxtOptions = {}

Returns

string


get_chapters()

get_chapters(first, last, options?): string

Defined in: client/src/book/bible.ts:466

Get txt for multiple chapters

Parameters

first

number

last

number

options?

GetTxtOptions = {}

Returns

string


get_chapter()

get_chapter(chapter, options?): string

Defined in: client/src/book/bible.ts:474

Get txt for a single chapter

Parameters

chapter

number

options?

GetTxtOptions = {}

Returns

string


get_verse()

get_verse(chapter, verse, options?): string

Defined in: client/src/book/bible.ts:479

Get txt for a single verse

Parameters

chapter

number

verse

number

options?

GetTxtOptions = {}

Returns

string


get_list()

get_list(start_chapter?, start_verse?, end_chapter?, end_verse?): IndividualVerse<TxtContent[]>[]

Defined in: client/src/book/bible.ts:484

Get txt as an array of individual verses

Parameters

start_chapter?

number

start_verse?

number

end_chapter?

number

end_verse?

number

Returns

IndividualVerse<TxtContent[]>[]


get_list_from_ref()

get_list_from_ref(ref): IndividualVerse<TxtContent[]>[]

Defined in: client/src/book/bible.ts:491

Get txt as an array of individual verses by passing a PassageReference object

Parameters

ref

PassageReference

Returns

IndividualVerse<TxtContent[]>[]