steemersict / bible-scraper

📖 Retrieve verses from bible.com/YouVersion.

bible-scraper

Retrieve verses from bible.com/YouVersion.

☁️ Installation

# Using npm
npm install --save bible-scraper

# Using yarn
yarn add bible-scraper

📋 Example

const BibleScraper = require("bible-scraper");

(async () => {
    // Create a Vulgata Latina instance
    const VulgataLatina = new BibleScraper(BibleScraper.TRANSLATIONS.VULG)
    const verse = await VulgataLatina.verse("1CO.13.4")
    console.log(verse)
    // => { content:
    //      'Caritas patiens est, benigna est. Caritas non æmulatur, non agit perperam, non inflatur',
    //     reference: 'ad Corinthios I 13:4 VULG' }

    // Create a KJV instance
    const kjv = new BibleScraper(BibleScraper.TRANSLATIONS.KJV)
    kjv.verse("1CO.13.4").then(console.log)
    // => { content:
    //     'Charity suffereth long, and is kind; charity envieth not; charity vaunteth not itself, is not puffed up',
    //    reference: '1 Corinthians 13:4 KJV' }

    // Create a NIV instance
    const niv = new BibleScraper(111)
    console.log(await niv.chapter("1CO.13"))
    // => { verses:
    //    [ { content:
    //         'If I speak in the tongues of men or of angels, but do not have love, I am only a resounding gong or a clanging cymbal.',
    //        reference: '1CO.13.1' },
    //      { content:
    //         'If I have the gift of prophecy and can fathom all mysteries and all knowledge, and if I have a faith that can move mountains, but do not have love, I am nothing.',
    //        reference: '1CO.13.2' },
    //        ...
    //      { content:
    //         'And now these three remain: faith, hope and love. But the greatest of these is love.',
    //        reference: '1CO.13.13' } ] }
})()

❓ Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. 🐛
3. For direct and quick help, you can use Codementor. 🚀

📝 Documentation

BibleScraper

Retrieves verses from bible.com, provided by YouVersion. Initializes the BibleScraper instance.

Params

• Number translationId: - The translation id from bible.com.

constructor

Constructor for the class.

Params

• type translationId: - the ID of the Bible translation.

url(reference)

Returns the Bible url reference from bible.com.

Params

• String reference: The Bible reference to get the url for.

Return

• String The reference url.

getBibleReference(params, params.book, params.chapter, [params.verseNumStart], [params.verseNumEnd])

Generates a bible reference based on the provided book, chapter, and verse range.

Params

• Object params: - The parameters object.
• string params.book: - The name of the book.
• number params.chapter: - The chapter number.
• number [params.verseNumStart]: - The starting verse number (optional).
• number [params.verseNumEnd]: - The ending verse number (optional).

Return

• string The generated bible reference.

verse Fetches the verse.

Params

• String ref: The Bible.com verse reference.

Return

• Promise A promise resolving the verse object.

chapter Fetches the chapter verses.

Params

• String ref: The Bible.com chapter reference.

Return

• Promise A promise resolving the chapter object.

BibleScraper.BOOKS

The available books from bible.com.

BibleScraper.TRANSLATIONS

The translation ID's from bible.com.

😋 How to contribute

Have an idea? Found a bug? See how to contribute.

💖 Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

• Starring and sharing the projects you like 🚀

• —I love books! I will remember you after years if you buy me one. 😁 📖

• —You can make one-time donations via PayPal. I'll probably buy a coffee tea. 🍵

• —Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

• Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

  

Thanks! ❤️

💫 Where is this library used?

If you are using this library in one of your projects, add it in this list. ✨

• @everything-registry/sub-chunk-1232

📜 License

MIT © Ionică Bizău