Zurück zu Open Source

Open Source

TypeScript · Lizenz: MIT

@midvash/bible-data

TypeScript/JavaScript-SDK zum Abrufen von Versen, Kapiteln und Büchern aus dem Datensatz bible-data.

Über das Projekt

Typisierte API über dem Datensatz bible-data, auf npm veröffentlicht als @midvash/bible-data. Läuft in Node 18+ (natives fetch), im Browser und in Edge-Runtimes (Cloudflare Workers, Vercel Edge). Stellt Funktionen wie getVerse(slug, book, chapter, verse), getChapter, getBook, getBible und getVersionMetadata bereit, dazu Konstanten wie ALL_VERSION_SLUGS, VERSIONS_BY_LANGUAGE, KNOWN_LANGUAGES und BOOK_IDS. Eigene Konfiguration über configure({ baseUrl, fetch }): nützlich, um ein bestimmtes Release des Datensatzes festzulegen oder ein fetch mit Caching, Retries oder Mocking einzubinden. Bücher werden über OSIS-Codes identifiziert (Gen, Exod, …, Rev). MIT-Lizenz. Die von der Bibliothek ausgelieferten Texte folgen der Lizenz der jeweiligen Übersetzung (angegeben in bible-data).

Was enthalten ist

  • getVerse / getChapter / getBook / getBible
  • Konstanten ALL_VERSION_SLUGS, VERSIONS_BY_LANGUAGE, BOOK_IDS
  • Konfigurierbar: eigene baseUrl, eigenes fetch
  • Läuft in Node, im Browser und in Edge-Runtimes
  • Vollständige TypeScript-Typen
  • Keine Abhängigkeiten

Installation

                npm install @midvash/bible-data
              

Verwendung

                import { getVerse, getChapter, getBook } from '@midvash/bible-data';

// John 3:16 in the King James Version
const verse = await getVerse('kjv', 'John', 3, 16);
console.log(verse.text);
// "For God so loved the world, that he gave his only begotten Son..."

// All of John 3 in the World English Bible
const chapter = await getChapter('web', 'John', 3);

// The whole book of Genesis in Latin (Vulgate)
const genesis = await getBook('vulg', 'Gen');
              

Mitwirken

Einen Fehler gefunden, fehlen Daten oder möchtest du etwas beitragen? Pull Requests und Issues sind willkommen unter github.com/midvash/bible-data-js .