# node-text-from-image

> Quick wrapper for Tesseract.js to extract text from images

Latest version **1.0.1** (published 2022-06-03) · ISC license · 0 weekly downloads

## Install

```sh
npm install node-text-from-image
pnpm add node-text-from-image
yarn add node-text-from-image
bun add node-text-from-image
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2022-06-03 |
| First published | 2022-06-03 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 6.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | ngregrichardson |
| Maintainers | ngregrichardson |
| Keywords | text, from, image, typescript, javascript, ocr, text from image, OCR image, nodejs ocr, read text, recognize text |

## Links

- npm: https://www.npmjs.com/package/node-text-from-image
- Homepage: https://github.com/ngregrichardson/node-text-from-image#readme
- Issues: https://github.com/ngregrichardson/node-text-from-image/issues
- npm.io page: https://npm.io/package/node-text-from-image

## Dependencies (1)

- [tesseract.js](https://npm.io/package/tesseract.js.md) ^2.1.4

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2022-06-03
- 1.0.0 — 2022-06-03

## README

# Node.js Text from Image

[![npm version](https://img.shields.io/npm/v/node-text-from-image.svg?style=flat-square)](https://www.npmjs.org/package/node-text-from-image)

A rewrite of [text-from-image](https://github.com/goyalabhi1305/tess-based-text-from-image) by [goyalabhi1305](https://github.com/goyalabhi1305) in TypeScript.

## Installation
```shell
npm install --save node-text-from-image
```

## Usage
This gives a promise  which can be used further for various uses

```typescript
import getTextFromImage from "node-text-from-image";

getTextFromImage("./image.png").then(text => {
    console.log(text);
}).catch(err => {
    console.log(err);
})
```

## Please take care
- Image can be any supported [Image Format](https://github.com/naptha/tesseract.js/blob/master/docs/image-format.md).
- The clear the image the better.
- You can use Sharp or other image processing library to modify image before sending it to the function

## Issues
If you run into any problems, please [create an issue](https://github.com/ngregrichardson/node-text-from-image/issues).

# Contributing
If you're interested in contributing, please follow the [GitHub repository](https://github.com/ngregrichardson/node-text-from-image).

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