Documentation Guides

New to zipnative? Start with the Quickstart — the four core workflows in about five minutes. For the full export surface, see api.json (mechanically extracted, never guessed).

Hands-on guides covering installation, the security model, the determinism contract and the frozen error vocabulary. Every guide is written as Markdown (the source of truth for the llms pipeline) and pre-rendered — use the “Copy page as Markdown” button on any guide to feed it to an agent.

• Quickstart → Install zipnative and cover the four core workflows — random-access reading, secure extraction, deterministic creation and incremental modification — in about five minutes.
• Security model → Every archive is untrusted input: the threat table, the CWE-tagged configurable bounds, the refusals that never opt out, and the forward reader's trust caveat.
• The determinism contract → Three guarantee levels, the frozen pure-TS encoder constants behind deterministic: true, and the documented ways reproducibility can be lost.
• Errors and error codes → The frozen machine-readable vocabulary (39 codes): branch on err.code, never on message text. Registry twin in docs/data/errors.json.
• Use cases → Four production architectures with diagrams, each built from shipped APIs — the manifest peek (openZip), untrusted-upload intake (extractZip), the reproducibility gate (deterministic: true), and streaming intake at the edge (iterateZipEntries).
• Conformance and validation → The authority story: the first open clause-by-clause ISO/IEC 21320-1:2015 validator (npm run validate:zip), the foreign integrity pass, and the six-parser differential extraction matrix — blocking in CI and before every publish.