Do not zip. Just store.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Conduitry 675ea5efe5 update readme 1 年之前
src add .toAuto to replicate previous behavior 1 年之前
test fix and update tests 1 年之前
.eslintrc.yaml docs and stuff 2 年之前
.gitignore update .gitignore for pnpm v3 1 年之前 v1.0.0 1 年之前
LICENSE docs and stuff 2 年之前 update readme 1 年之前
package.json v1.0.0 1 年之前
rollup.config.js switch to separate explicit functions for different kinds of output 1 年之前
rollup.config.test.js Adding tests for browser and node 2 年之前


npm version

Do not zip. Just store.


Stick some text files into a zip file. This library is super simple and small because it just stores the files without compressing them, which is often sufficient when all you want to do is let the user download some files generated in the browser. Works on the server (Node.js) and on the client (JavaScript). Requires ES2015+.


import * as doNotZip from 'do-not-zip';

// on the server or the client:
const byteArray = doNotZip.toArray([
	// each file should have:
	// - 'path' - a string
	// - 'data' - a string, or an array of bytes or Uint8Array or Buffer or anything else that gives integers when indexed
	{ path: 'path/to/file1.txt', data: 'Hello' },
	{ path: 'another/file2.txt', data: 'World' },
	{ path: 'yet/another/file3.bin', data: [1, 2, 3, 4, 5] },
	// ...
// => output will be an array of bytes

// on the server:
const buffer = doNotZip.toBuffer([ ... ]);
// => output will be a Buffer

// on the client:
const blob = doNotZip.toBlob([ ... ]);
// => output will be a Blob

// on the server or the client:
const bufferOrBlob = doNotZip.toAuto([ ... ]);
// => output will be a Buffer on the server and a Blob on the client
// (which one to return is determined by whether there is a Blob global defined)