free-use-bible-sdk
v1.0.1
Published
TypeScript SDK for Free Use Bible API
Downloads
275
Readme
Free Use Bible SDK
Add Bible text to your website or web app without having to worry about licensing and legal issues surrounding Bible text.
This is a type-safe Bible SDK to use in your web apps and websites.
Installation
npm install free-use-bible-sdkUsage
import { FreeUseBibleSDK } from "free-use-bible-sdk";
const client = new FreeUseBibleSDK({
baseUrl: "https://bible.helloao.org/",
});
const chapterResponse = await client.general.getChapterFromTranslation(
"BSB",
"Romans",
8,
);
console.log(chapterResponse);OpenAPI spec (created based on these docs) + apigen-ts = FreeUseBibleSDK
Bible text comes from the Free Use Bible API, generously provided by AO Lab.
API Overview
The SDK provides access to Bible translations and commentaries through the following methods:
Translations
getAvailableTranslations()- Get list of available Bible translationsgetBooksForTranslation(translation: string)- Get books for a specific translationgetChapterFromTranslation(translation: string, book: string, chapter: number)- Get chapter content
Commentaries
getAvailableCommentaries()- Get list of available commentariesgetBooksForCommentary(commentary: string)- Get books for a commentarygetChapterFromCommentary(commentary: string, book: string, chapter: number)- Get commentary chaptergetProfilesForCommentary(commentary: string)- Get profiles for a commentarygetProfileFromCommentary(commentary: string, profile: string)- Get specific profile content
All methods return typed responses with full TypeScript support.
Let me know how I can make it better.
— Cam
