Skip to content

Repository files navigation

@aklinker1/zero-zip

JSR NPM Version API Reference License

Zero dependency, tiny util for creating ZIP files.

pnpm add @aklinker1/zero-zip
bun  add @aklinker1/zero-zip
deno add @aklinker1/zero-zip

Usage

import { writeFile } from "node:fs/promises"
import { createZip, type Zip } from '@aklinker1/zero-zip'

const zip = createZip();
zip.addFile("hello.txt", "Hello, world!")
const buffer = await zip.toBuffer()

await writeFile("example.zip", buffer)

Supported Runtimes

Any runtime with access to node:zlib:

  • ✅ Node, Deno, Bun
  • ❌ Browser

Features

  • Compression options
  • Files & files in directories

Not Supported

  • Unzipping
  • Standalone directory entries
  • Unix permissions are not preserved

About

Zero dependency, tiny util for creating ZIP files

Topics

Resources

Stars

Watchers

Forks

Releases

Contributors

Languages