Retour à l'Open Source

Open Source

TypeScript · Licence: MIT

@midvash/bible-data

SDK TypeScript/JavaScript pour lire les versets, chapitres et livres du jeu de données bible-data.

À propos du projet

API typée au-dessus du jeu de données bible-data, publiée sur npm sous le nom @midvash/bible-data. Fonctionne sous Node 18+ (fetch natif), dans les navigateurs et dans les runtimes edge (Cloudflare Workers, Vercel Edge). Expose des fonctions comme getVerse(slug, livre, chapitre, verset), getChapter, getBook, getBible et getVersionMetadata, ainsi que des constantes comme ALL_VERSION_SLUGS, VERSIONS_BY_LANGUAGE, KNOWN_LANGUAGES et BOOK_IDS. Accepte une configuration personnalisée via configure({ baseUrl, fetch }) : pratique pour figer une release précise du jeu de données ou injecter un fetch avec cache, nouvelles tentatives ou mocks. Les livres sont identifiés par des codes OSIS (Gen, Exod, …, Rev). Licence MIT. Les textes servis par la bibliothèque suivent la licence propre à chaque version (déclarée dans bible-data).

Ce qui est inclus

  • getVerse / getChapter / getBook / getBible
  • Constantes ALL_VERSION_SLUGS, VERSIONS_BY_LANGUAGE, BOOK_IDS
  • Configurable : baseUrl personnalisée, fetch personnalisé
  • Fonctionne sous Node, dans le navigateur et en runtime edge
  • Types TypeScript complets
  • Zéro dépendance

Installation

                npm install @midvash/bible-data
              

Utilisation

                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');
              

Contribuer

Vous avez trouvé un bug, des données manquantes, ou vous voulez ajouter quelque chose ? Les pull requests et issues sont les bienvenues sur github.com/midvash/bible-data-js .