@gracious.tech/fetch-client / client / BibleClientConfig

Interface: BibleClientConfig ​

client.BibleClientConfig

The options available for configuring a BibleClient

Properties ​

endpoints ​

• Optional endpoints: string[]

A list of CDN endpoints to connect to that defaults to the official CDN (https://collection.fetch.bible/). You can optionally host your own fetch(bible) collection and use that instead, or you could use it in addition to the official CDN by listing it first. The values can be relative URLs but all must end in a slash.

Defined in ​

client.ts:17

usage ​

• Optional usage: Partial<UsageConfig>

Configure how you'll be using Bible translations to automatically filter out those which have incompatible licenses. You can alternatively do this per translation when fetching actual passages.

All options default to false which results in having access to the most translations.

• commercial: true if you will use translations in a commercial manner
• attributionless: true if you will be using Bible translations without including attribution to the owners
• limitless: true if you will be using translations in full without any limitations to the number of verses that can be quoted
• derivatives: true if you'll be modifying the translations, or same-license if you'll be sharing modifications under the same license as the original

Defined in ​

client.ts:33