Node

Caution

On Node, this package requires >=22.12. It parses XML with xmldoc, which is ESM-only from version 3, so reaching this package through require() needs the require(esm) support that landed unflagged in Node 22.12. import and bundler builds are unaffected. The same applies to archive-reader and metadata-fetcher.

The streamer is source-agnostic — in node you can feed it from a zip library, an extraction tool, raw buffers, URLs, or your own custom source. Pick whatever fits your stack; the only requirement is to turn your source into an Archive (see Archive Reader for the full list of creators and how to build your own).

As one example, opening a zip-based container (EPUB, CBZ) with unzipper:

import {
  generateManifestFromArchive,
  generateResourceFromArchive,
} from "@prose-reader/streamer"
import { createArchiveFromUnzipper } from "@prose-reader/archive-reader/archives/createArchiveFromUnzipper"
import unzipper from "unzipper"

const directory = await unzipper.Open.file("book.epub")
const archive = await createArchiveFromUnzipper(directory, { name: "book.epub" })

const manifest = await generateManifestFromArchive(archive)
const resource = await generateResourceFromArchive(archive, "OEBPS/chapter1.xhtml")

Note

Each library-backed creator (unzipper, libarchive.js, jszip, node-unrar-js) is an optional peer dependency exposed as a subpath import, so you only install and bundle the one you actually use.