Appearance
@gracious.tech/fetch-client / book / BibleBookHtml
Class: BibleBookHtml
book.BibleBookHtml
Access to the HTML text of a Bible book
Methods
get_attribution
▸ get_attribution(license?): string
Get appropriate text for attribution (defaults to first license, optionally provide one)
Parameters
| Name | Type |
|---|---|
license? | RuntimeLicense |
Returns
string
Defined in
get_whole
▸ get_whole(«destructured»?): string
Get the HTML for the entire book
Parameters
| Name | Type |
|---|---|
«destructured» | GetPassageOptions |
Returns
string
Defined in
get_passage
▸ get_passage(start_chapter, start_verse, end_chapter, end_verse, options?): string
Get HTML for a specific passage
Parameters
| Name | Type |
|---|---|
start_chapter | number |
start_verse | number |
end_chapter | number |
end_verse | number |
options | GetPassageOptions |
Returns
string
Defined in
get_passage_from_ref
▸ get_passage_from_ref(ref, options?): string
Get HTML for a specific passage specified by a PassageReference object
Parameters
| Name | Type |
|---|---|
ref | PassageReference |
options | GetPassageOptions |
Returns
string
Defined in
get_chapters
▸ get_chapters(first, last, options?): string
Get HTML for multiple chapters
Parameters
| Name | Type |
|---|---|
first | number |
last | number |
options | GetPassageOptions |
Returns
string
Defined in
get_chapter
▸ get_chapter(chapter, options?): string
Get HTML for a single chapter
Parameters
| Name | Type |
|---|---|
chapter | number |
options | GetPassageOptions |
Returns
string
Defined in
get_verse
▸ get_verse(chapter, verse, options?): string
Get HTML for a single verse
Parameters
| Name | Type |
|---|---|
chapter | number |
verse | number |
options | GetPassageOptions |
Returns
string
Defined in
get_list
▸ get_list(start_chapter?, start_verse?, end_chapter?, end_verse?): IndividualVerse<string>[]
Get HTML as an array of individual verses (each verse will be in its own paragraph)
Parameters
| Name | Type |
|---|---|
start_chapter? | number |
start_verse? | number |
end_chapter? | number |
end_verse? | number |
Returns
IndividualVerse<string>[]
Defined in
get_list_from_ref
▸ get_list_from_ref(ref): IndividualVerse<string>[]
Get HTML as an array of individual verses by passing a PassageReference object
Parameters
| Name | Type |
|---|---|
ref | PassageReference |
Returns
IndividualVerse<string>[]