npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

nodejs-ocr

v1.1.3

Published

A simple and easy to use client to perform OCR using ABBYY Cloud OCR SDK.

Downloads

27

Readme

nodejs-ocr

A simple and easy to use client to perform OCR using ABBYY Cloud OCR SDK.

Unlike the alternatives, ABBYY's OCR is simple and practical. It's perfect for reliably reading basic text from pictures, documents, cheques, receipts and business cards. Requires no setup. OCR results are dependably consistent - the same input will never yield different results.

Implements the processImage, submitImage, processDocument, processTextField and processFields methods from the OCR SDK API.

Quick Start

Install

$ npm install nodejs-ocr

Import

let AbbyyClient = require('nodejs-ocr');

Creating a client object

  • Provide your Abbyy application id and password, available free at: http://ocrsdk.com
  • Provide the protocol (http/https) and server hostname.
let client = new AbbyyClient('myAppId', 'myPassword', 'https://cloud.ocrsdk.com'); // Use https here if you'd like

Running an API method and using the results

  • More information on API Parameters can be found here: API Reference.
function ocrComplete(err, results) {
    if( !err ) {
        console.log(results.toString()); // Raw results of completed Task (or a TaskId for submitImage calls)
    }
}

let apiParameters = {
    language: 'English',
    profile:  'textExtraction',
    textType: 'typewriter',
    exportFormat: 'xml'
    // etc...
};
client.processImage(apiParameters, './localFile.png', ocrComplete); // Buffers can also be passed

Documentation

processImage([parameters], uploadData, callback)

  • [parameters] <Object> Optional Abbyy API method parameters. Object with string properties.
  • uploadData <string> or <Buffer> Image to be processed by API method.
  • callback(err, results) <Function> Callback to return errs or OCR results.

processTextField(parameters, uploadData, callback)

  • parameters <Object> Abbyy API method parameters. A text field region must be specified.

  • uploadData <string> or <Buffer> File to be processed by API method.

  • callback(err, results) Callback to return errs or OCR results.

submitImage([parameters], uploadData, callback)

  • [parameters] <Object> Optional Abbyy API method parameters.

  • uploadData <string> or <Buffer> File to be uploaded to Abbyy server.

  • callback(err, results) <Function> Callback to return errs or Task ID string representing uploaded file.

processDocument(parameters, callback)

  • parameters <Object> Abbyy API method parameters. Task ID corresponding to a file uploaded via submitImage is required.

  • callback(err, results) <Function> Callback to return errs or OCR results.

processFields(parameters, uploadData, callback)

  • parameters <Object> Abbyy API method parameters. Task ID corresponding to a file uploaded via submitImage is required.

  • uploadData <string> or <Buffer> XML representing fields to be processed by API method. For more information on the format of this XML see: XML Parameters of Field Recognition.

  • callback(err, results) <Function> Callback to return errs or OCR results.