Package Exports

mindee
mindee/src/index.js

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!

Loading a File and Parsing It

Global Documents

const mindee = require("mindee");
// for TS or modules:
// import * as mindee from "mindee";

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

// Load a file from disk and parse it
const apiResponse = mindeeClient
    .docFromPath("/path/to/the/file.ext")
    .parse(mindee.InvoiceV4);

Region-Specific Documents

const mindee = require("mindee");
// for TS or modules:
// import * as mindee from "mindee";

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

// Load a file from disk and parse it
const apiResponse = mindeeClient
    .docFromPath("/path/to/the/file.ext")
    .parse(mindee.fr.IdCardV1);

Custom Documents (API Builder)

const mindee = require("mindee");
// for TS or modules:
// import * as mindee from "mindee";

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

// Load a file from disk and parse it
const apiResponse = mindeeClient
    .docFromPath("/path/to/the/file.ext")
    .parse(mindee.CustomV1, { endpointName: "wsnine" });

Handling the Return

// Handle the response Promise
apiResponse.then((resp) => {

    // The `document` property can be undefined:
    // * TypeScript will not compile without this guard clause
    //   (or consider using the '?' notation)
    // * JavaScript will be very happy to produce subtle bugs
    //   without this guard clause
    if (resp.document === undefined) return;

    // full object
    console.log(resp.document);

    // string summary
    console.log(resp.document.toString());
});

License

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

mindee