@nextgensoftwares/folio-import-formats
Importers for every format except Word (that's @nextgensoftwares/folio-docx), one entry per format. Guide: Import.
Root entry (lazy)
| Export | Description |
|---|---|
allImporters() | every format, in importFile order (magic bytes first, plain text last); parsers load on first use |
lazyImporters | the same, by name: pdf, rtf, epub, odt, html, markdown, text |
lazyImporter(info, load) | wraps any importer so it loads on first use |
defineImporter(info, run, defaultLimits?), type FormatInfo | builds an Importer around an ImportContext |
ImportContext | per-import state: limits, warn, tick(progress?), progress, addBlocks, full, assets, result(format, content, extra) |
ImportAbortedError, ImportLimitError | cancelled (name: 'AbortError') / over a hard limit |
DEFAULT_LIMITS, type Limits | 200 MB, 10,000 entries, 500,000 blocks (formats override) |
htmlInfo, markdownInfo, textInfo, odtInfo, rtfInfo, epubInfo, pdfInfo | each format's extensions, MIME types and sniff |
Format entries
| Entry | Exports |
|---|---|
@nextgensoftwares/folio-import-formats/html | htmlImporter, htmlInfo, convertHtml(html, ctx, { xhtml?, resolveImage? }), decodeHtml(bytes), type ConvertHtmlOptions, type HtmlMeta |
@nextgensoftwares/folio-import-formats/markdown | markdownImporter, markdownInfo |
@nextgensoftwares/folio-import-formats/text | textImporter, textInfo |
@nextgensoftwares/folio-import-formats/odt | odtImporter, odtInfo |
@nextgensoftwares/folio-import-formats/rtf | rtfImporter, rtfInfo |
@nextgensoftwares/folio-import-formats/epub | epubImporter, epubInfo |
@nextgensoftwares/folio-import-formats/pdf | pdfImporter, pdfInfo, PDF_MAX_PAGES, reconstruct(pages) (text items → blocks, pure), PdfPasswordError, type PdfWorkerFactory, type PdfPageData, type PdfTextItem, type PdfPlacedImage, type ReconstructResult |
PDF options (in ImportOptions): pdfWorker?: () => Worker | null, maxPages? (default 2,000), images?: false. pdfjs-dist is an optional peer dependency, needed only for PDF.
Dependencies
All permissive: htmlparser2 (MIT), markdown-it + markdown-it-footnote (MIT), fflate (MIT), pdfjs-dist (Apache-2.0, optional peer).