Skip to content

@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

NameType
configBibleClientConfig

Defined in

client/src/client.ts:80

Properties

collection

collection: undefined | BibleCollection

Synchronous access to collection if it has already been fetched with fetch_collection()

Defined in

client/src/client.ts:77

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

client/src/client.ts:88


fetch_crossref

fetch_crossref(book, size?): Promise<BookCrossref>

Fetch cross-reference data for a book

Parameters

NameTypeDefault value
bookstringundefined
size"small" | "medium" | "large"'medium'

Returns

Promise<BookCrossref>

Defined in

client/src/client.ts:118