Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

tesseractocr

2.0.0 • Public • Published

view on npm downloads per month node version build status test coverage license

Tesseract OCR for Node.js

Simple and modern Node.js wrapper implementation for Tesseract OCR CLI.

Features & Advantages

  • focus on high performance
  • both promise and callback APIs are supported
  • full test coverage
  • void of sync operations
  • no temp files are used

Usage

const recognize = require('tesseractocr')
 
async function main() {
    const text = await recognize(`${__dirname}/image.png`)
    console.log('Yay! Text recognized:', text)
}
 
main()
 

Note: Despite that it's encouraged to use the more modern promise-based API, the good old callbacks are still supported.

API docs

The overall API documentation can be found here

Installation

There is a hard dependency on the Tesseract project. You can find installation instructions for various platforms on the project site. For Homebrew users, the installation is quick and easy.

brew install tesseract

You can then go about installing the Node.js package to expose the JavaScript API:

npm install tesseractocr

Tests and benchmarks

Clone the repo, npm install and then npm test or npm run benchmarks.

Changelog

The project's changelog is available here

License

MIT

Install

npm i tesseractocr

DownloadsWeekly Downloads

131

Version

2.0.0

License

MIT

Unpacked Size

15.7 kB

Total Files

12

Last publish

Collaborators

  • avatar