@markitdownjs/archive

ZIP/archive converter for MarkItDownJS. Extracts and converts files inside ZIP archives, returning a document node per contained file.

Install

npm install @markitdownjs/archive @markitdownjs/core

Usage

import { MarkItDown } from "@markitdownjs/core";
import { ArchiveConverter } from "@markitdownjs/archive";

const parser = new MarkItDown();
parser.registerConverter(new ArchiveConverter());

const result = await parser.convert({ source: zipBuffer, mimeType: "application/zip" });

Each file inside the archive is converted individually. The output document contains one child node per extracted file, with filename and mimeType preserved in node metadata.

API

ArchiveConverter

Implements the IConverter interface from @markitdownjs/core.

| Method | Description | |--------|-------------| | convert(input) | Extracts archive entries and converts each to a document node | | canHandle(mimeType) | Returns true for application/zip and application/x-zip-compressed |

Nested converters are resolved from the MarkItDown instance registered at construction time. Register all required format converters before processing archives.

Part of the MarkItDownJS Monorepo

https://github.com/markitdownjs/markitdownjs