Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (mindee) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Mindee API Helper Library for Node.js

Quickly and easily connect to Mindee's API services using Node.js.

Quick Start

Here's the TL;DR of getting started.

First, get an API Key

Then, install this library:

npm install mindee

Finally, Node.js away!

Off-the-Shelf Document

import { Client, InvoiceResponse } from "mindee";

// Init a new client
const mindeeClient = new Client({apiKey: "my-api-key"});

// Load a file from disk and parse it
const invoiceResponse = mindeeClient.docFromPath("/path/to/the/invoice.pdf")
  .parse(InvoiceResponse);

// Print a brief summary of the parsed data
invoiceResponse.then((resp) => {
  console.log(resp.document);
});

Custom Document (API Builder)

import { Client, CustomResponse } from "mindee";

// Init a new client and add your document endpoint
const mindeeClient = new Client({apiKey: "my-api-key"})
  .addEndpoint({
    accountName: "john",
    documentType: "wsnine",
});

// Load a file from disk and parse it
const customResponse = mindeeClient.docFromPath("/path/to/the/wsnine.jpg")
  .parse(CustomResponse, {docType: "wsnine"});

// Print a brief summary of the parsed data
customResponse.then((resp) => {
  console.log(resp.document);
});

License

Available as open source under the terms of the MIT License.

mindee