Appearance
@gracious.tech/fetch-client / client / BibleClient
Class: BibleClient
client.BibleClient
A client for interacting with a fetch(bible) CDN
Constructors
constructor
• new BibleClient(config?
)
Create a new BibleClient, defaulting to the official fetch(bible) collection
Parameters
Name | Type |
---|---|
config | BibleClientConfig |
Defined in
Properties
collection
• collection: undefined
| BibleCollection
Synchronous access to collection if it has already been fetched with fetch_collection()
Defined in
Methods
fetch_collection
▸ fetch_collection(): Promise
<BibleCollection
>
Fetch the collection’s manifest and return a BibleCollection object for interacting with it
Returns
Promise
<BibleCollection
>
Defined in
fetch_crossref
▸ fetch_crossref(book
, size?
): Promise
<BookCrossref
>
Fetch cross-reference data for a book
Parameters
Name | Type | Default value |
---|---|---|
book | string | undefined |
size | "small" | "medium" | "large" | 'medium' |
Returns
Promise
<BookCrossref
>