do-not-zip
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/do-not-zip package

1.0.0 • Public • Published

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

Readme

Keywords

Package Sidebar

Install

npm i do-not-zip

Weekly Downloads

23,819

Version

1.0.0

License

MIT

Unpacked Size

17 kB

Total Files

8

Last publish

Collaborators

  • conduitry