# bible-crawler

> A module to read, extract and storage bible data from websites.

Latest version **0.0.1** (published 2021-08-31) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install bible-crawler
pnpm add bible-crawler
yarn add bible-crawler
bun add bible-crawler
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2021-08-31 |
| First published | 2021-08-31 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 94.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Lucas Lannes |
| Maintainers | lucaslannes |

## Links

- npm: https://www.npmjs.com/package/bible-crawler
- Repository: https://github.com/lucaslannes/bible-crawler
- Homepage: https://github.com/lucaslannes/bible-crawler#readme
- Issues: https://github.com/lucaslannes/bible-crawler/issues
- npm.io page: https://npm.io/package/bible-crawler

## Dependencies (2)

- [cross-fetch](https://npm.io/package/cross-fetch.md) ^3.1.4
- [node-html-parser](https://npm.io/package/node-html-parser.md) ^4.1.3

## Recent versions

- 0.0.1 (latest) — 2021-08-31

## README

# Bible Crawler
A module to read, extract and storage bible data from websites.

## Built-in Crawlers
There is some crawlers available to fetch specific bible versions:

| Crawler            | .languages()        | .readAllBooks() |
|--------------------|---------------------|-----------------|
| BibliaLivreCrawler | pt_BR               | 20 min          |
| Just1WordCrawler   | en_US, ja_JP, pt_BR | 60 min          |
| WordProjectCrawler | ja_JP, ko_KR        | 60 min          |

## IBibleCrawler
IBibleCrawler is an interface implemented by crawlers.

### `languages(): Language[]`
Returns all available languages.

### `title(book: BookOf, language: Language): Promise<string>`
Returns the `book` title.

### `read(book: BookOf, chapter: number, language: Language): Promise<string[]>`
Returns an array of verses of `book` `chapter`.

### `readAllChapters(book: BookOf, language: Language): Promise<string[][]>`
Returns a 2D array as `(chapter, verse)`.

### `readAllBooks(language: Language): Promise<string[][][]>`
Returns a 3D array as `(book, chapter, verse)`.

## BaseCrawler
BaseCrawler is an abstract class to provide already implemented methods from IBibleCrawler.

These methods were implemented: `languages`, `readAllChapters`, `readAllBooks`.

If you need custom stuff, implement IBibleCrawler or override BaseCrawler.

---
_Source: https://npm.io/package/bible-crawler · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._