npm

Share private packages across your team with npm Orgs, now with simplified billing via the aws marketplace!Learn more »

epub-full-text-search

0.0.8 • Public • Published

Build Status

EPUB-Search

Search engine for EPUB3 documents

This node module is a search engine for EPUB3 documents. It provides full-text searching on EPUB3 content. It is built on top of search-index.

Features include:

  • Full text search
  • Instant search (provide suggestions)
  • Full javascript
  • Hits including cfi references

Usage

Create a new search engine object

var se = new SearchEngine();

Indexing

run this function to index your unzipped EPUB3 content

se.indexing('your_epub(s)_directory', function (info) {
       console.log(info);
});

Searching

// search(query, epubTitle, result_callback)
se.search(["epub"], "Accessible EPUB 3", function (results) {
});

Installation

Example

Install all dependent modules: npm install.

Start up the example npm run express-service. It should run an express server on your local machine.

When navigating to http://localhost:8080/ then you can see a test page where you can enter a search query.

Note: The indexing process starts automatically and it takes a few seconds until the search service is really available.

install

npm i epub-full-text-search

Downloadsweekly downloads

48

version

0.0.8

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability