1
Fork 0
Do not zip. Just store. https://conduitry.dev/do-not-zip
Go to file
Conduitry 1bacd272fb update .gitignore for pnpm v3 2019-03-19 14:39:31 -04:00
src add .toAuto to replicate previous behavior 2018-11-07 06:42:10 -05:00
test fix and update tests 2018-11-07 06:45:20 -05:00
.eslintrc.yaml docs and stuff 2018-04-19 12:25:25 -04:00
.gitignore update .gitignore for pnpm v3 2019-03-19 14:39:31 -04:00
CHANGELOG.md v1.0.0 2018-11-07 07:00:47 -05:00
LICENSE docs and stuff 2018-04-19 12:25:25 -04:00
README.md add .toAuto to replicate previous behavior 2018-11-07 06:42:10 -05:00
package.json v1.0.0 2018-11-07 07:00:47 -05:00
rollup.config.js switch to separate explicit functions for different kinds of output 2018-11-05 10:01:10 -05:00
rollup.config.test.js Adding tests for browser and node 2018-04-19 22:29:15 -04:00

README.md

do-not-zip

npm version

Do not zip. Just store.

What

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+.

How

import * as doNotZip from 'do-not-zip';
const output = doNotZip.toArray([
	{ 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
// use .toBuffer on the server to generate a Buffer, and use .toBlob on the client to generate a Blob
// use .toAuto to generate a Buffer on the server or a Blob on the client

Thanks

License

Copyright (c) 2018 Conduitry