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

@ragaeeb/ocr-js

v1.0.0

Published

Library to OCR documents using 3rd party libraries

Downloads

83

Readme

Table of Contents

wakatime GitHub npm npm GitHub issues GitHub stars GitHub Release codecov Size typescript

The ocr-js project simplifies the process of performing OCR on documents sent to 3rd party services like Google Document AI.

ocr-js Usage Guide

This guide explains how to use the exported functions from ocr-js.

Installation

npm i @ragaeeb/ocr-js

Prerequisites

Node.js (v20 or higher) Google Cloud account with Document AI and Cloud Storage enabled Service account credentials with necessary permissions.

Configuration

Before using the functions, you need to initialize the configuration:

import { init } from './index';

init({
    bucketUri: 'gs://your-bucket-name',
    processorId: 'your-processor-id',
    processorVersion: 'your-processor-version',
    projectId: 'your-project-id',
    projectLocation: 'your-project-location',
});
  • bucketUri: The URI of your Google Cloud Storage bucket.
  • processorId: The ID of your Document AI processor.
  • processorVersion: The version of your processor.
  • projectId: Your Google Cloud project ID.
  • projectLocation: The location of your processor (e.g., us-central1).

Usage

Initialization

Initialize the configuration as shown above before calling any other functions.

Requesting OCR

To request OCR processing for a PDF file:

import { requestOCR } from './index';

const pdfFile = 'path/to/your/file.pdf'; const options = { language: 'en', // Specify language hints };

requestOCR(pdfFile, options) .then((result) => { console.log('OCR request successful:', result); }) .catch((error) => { console.error('Error requesting OCR:', error); });

Retrieving OCR Results

After the OCR processing is complete, retrieve the results:

import { getOCRResult } from './index';

const requestId = 'your-request-id'; // Use the requestId from the requestOCR result

getOCRResult(requestId)
    .then((pages) => {
        console.log('OCR results:', pages);
    })
    .catch((error) => {
        console.error('Error retrieving OCR results:', error);
    });

Contributing

Contributions are welcome! Please submit a pull request or open an issue to discuss changes.

License

This project is licensed under the MIT License.