# node-tezzeract

> A simple wrapper for the Tesseract OCR

Latest version **0.0.3** (published 2024-03-19) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install node-tezzeract
pnpm add node-tezzeract
yarn add node-tezzeract
bun add node-tezzeract
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2024-03-19 |
| First published | 2019-04-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 11.9 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Ilya Huraliuk |
| Maintainers | razmki |
| Keywords | tesseract, ocr, text recognition, fixed psm |

## Links

- npm: https://www.npmjs.com/package/node-tezzeract
- Repository: https://github.com/razmki/node-tesseract
- Homepage: https://github.com/razmki/node-tesseract#readme
- Issues: https://github.com/razmki/node-tesseract/issues
- npm.io page: https://npm.io/package/node-tezzeract

## Dependencies (2)

- [glob](https://npm.io/package/glob.md) ^5.0.10
- [uuid](https://npm.io/package/uuid.md) ^3.0.0

## Recent versions

- 0.0.3 (latest) — 2024-03-19
- 0.0.1 — 2019-04-02

## README

# Tesseract for node.js

[![NPM](https://nodei.co/npm/node-tezzeract.png)](https://nodei.co/npm/node-tezzeract/)

A simple wrapper for the Tesseract OCR package for node.js

## PLEASE READ THIS
- consider sanitizing inputs to `exec` such that they do not contain shell meta-characters such as `$()`.

---Thanks Nuno for that---

## Requirements

* Tesseract 3.01 or higher is needed for this to work

## Installation
There is a hard dependency on the [Tesseract project](https://github.com/tesseract-ocr/tesseract).  You can find installation instructions for various platforms on the project site. For Homebrew users, the installation is quick and easy.

    brew install tesseract --with-all-languages

The above will install all of the language packages available, if you don't need them all you can remove the `--all-languages` flag and install them manually, by downloading them to your local machine and then exposing the `TESSDATA_PREFIX` variable into your path:

    export TESSDATA_PREFIX=~/Downloads/

You can then go about installing the node-module to expose the JavaScript API:

    npm install node-tesseract

## Usage

```JavaScript
var tesseract = require('node-tesseract');

// Recognize text of any language in any format
tesseract.process(__dirname + '/path/to/image.jpg',function(err, text) {
	if(err) {
		console.error(err);
	} else {
		console.log(text);
	}
});

// Recognize German text in a single uniform block of text and set the binary path

var options = {
	l: 'deu',
	psm: 6,
	binary: '/usr/local/bin/tesseract'
};

tesseract.process(__dirname + '/path/to/image.jpg', options, function(err, text) {
	if(err) {
		console.error(err);
	} else {
		console.log(text);
	}
});
```

## Changelog
* **0.2.7**: Adds output file extension detection
* **0.2.6**: Catches exception when deleting tmp files that do not exist
* **0.2.5**: Preserves whitespace and replaces tmp module
* **0.2.4**: Removes console logging for messaging
* **0.2.3**: The ability to set the binary path via the config object.  Better installation documentation.
* **0.2.2**: Adds test converage to utils module
* **0.2.1**: Strips leading & trailing whitespace from output by default
* **0.2.0**: Adds ability to pass options via a configuration object.
* **0.1.1**: Updates tmp module.
* **0.1.0**: Removes preprocessing functionatlity.  See #3.
* **0.0.3**: Adds basic test coverage for process method
* **0.0.2**: Pulls in changes by [joscha](https://github.com/joscha) including: refactored to support tesseract 3.01, added language parameter, config parameter, documentation, Added support for custom preprocessors, OTB Preprocessor using ImageMagick 'convert'
* **0.0.1**: Initial version

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