1.0.6 • Published 2 years ago
bible-gateway-wrapper v1.0.6
Bible Gateway Wrapper
A simple Node module for interacting with the content on Bible Gateway.
Source Code Link: https://github.com/azumbro/BibleGatewayWrapper
NPM Link: https://www.npmjs.com/package/bible-gateway-wrapper
Usage
1) Get the bible-gateway-wrapper module by running npm install bible-gateway-wrapper
.
2) Made the wrapper callable from your code by importing it using import { getBibleChapter } from "bible-gateway-wrapper"
or const bibleGatewayWrapper = require("bible-gateway-wrapper")
.
3) Call the wrapper using
```
const result = await getBibleChapter(book, chapter, version, format, includeFootnotes)
```
or
```
const result = await bibleGatewayWrapper.getBibleChapter(book, chapter, version, format, includeFootnotes)
```
with the arguments described below.
- `book`: The book of the Bible for which to fetch content. See options under "Bible Book List" at [biblegateway.com/](https://www.biblegateway.com/).
- `chapter`: The chapter from the specified book of the Bible for which to fetch content. See options under "Bible Book List" at [biblegateway.com/](https://www.biblegateway.com/).
- `version`: The Bible version for which to fetch content. See options in dropdown at [biblegateway.com/](https://www.biblegateway.com/).
- `format` (optional, defaults to `html`): The format in which to return content. Options are `html` (returns the content as an HTML string), `html-array` (returns the content as an array of HTML strings split by verse), `text` (returns the content as a plaintext string), or `text-array` (returns the content as an array of plaintext strings split by verse).
- `includeFootnotes` (optional, defaults to `false`): Boolean value specifying whether or not to include footnotes in the returned content.
Example
Code:
import { getBibleChapter } from "bible-gateway-wrapper"
(async () => {
const output = await getBibleChapter("Psalms", 117, "RSVCE", "html-array")
console.log(output)
})().catch((e) => console.log(e))
Output:
[
'Universal Call to Worship',
'<span class="chapternum">117 </span>Praise the <span style="font-variant: small-caps" class="small-caps">Lord</span>, all nations!',
'Extol him, all peoples!',
'<sup class="versenum">2 </sup>For great is his steadfast love toward us;',
'and the faithfulness of the <span style="font-variant: small-caps" class="small-caps">Lord</span> endures for ever.',
'Praise the <span style="font-variant: small-caps" class="small-caps">Lord</span>!'
]