Scribe.js Files

This release makes it possible to open and work with multiple documents at the same time. This required updating the interface, so this is a breaking release that likely requires changes to your code. See Migration below. New Guide, API Reference, and CLI Reference.

Highlights

• ScribeDoc API. scribe.openDocument(files) returns a document object you operate on directly. Multiple documents can be open at once. (Guide)
• Settings off globals. Per-operation options moved from scribe.opt onto the method or ScribeDoc that uses them. (Configuration)
• Faster bundled OCR. The updated internal OCR model runs significantly faster (0-30% depending on corpus).

Migration

:::js
// Before
await scribe.importFiles(files);
await scribe.recognize({ langs: ['eng'] });
await scribe.download('pdf', 'out.pdf');

// After
const doc = await scribe.openDocument(files);
await doc.recognize({ langs: ['eng'] });
await doc.download('pdf', 'out.pdf');
await doc.terminate();

The removed module-level functions (importFiles, recognize, download, exportData, addHighlights, clear, compareOCR, convertOCRPage, evalOCRPage, extractInternalPDFText, …) all have ScribeDoc equivalents. scribe.extractText() is unchanged.

Full Changelog: https://github.com/scribeocr/scribe.js/compare/v0.11.10...v0.12.0