npm

npm’s 2019 JavaScript ecosystem survey analysis is now available!Get your copy here »

dtz

1.0.2 • Public • Published

dtz

npm npm Build Status Coverage Status

recursive-readdir + jszip

zip a directory manipulated by cli/promise (and callback).

Installation

yarn add dtz

Usage

CLI

Usage: dtz [options] <src>
 
  Options:
 
    -V, --version              output the version number
    -o, --out-file <path>      dest zip path
    -i, --ignores  <filename>  ignore filenames
    -v, --verbose
    -h, --help                 output usage information

When -o is empty, zip will be generated next to src.

Node.js

import dtz from 'dtz';
 
const src = `./app`;
 
// promise
dtz(src,[`foo.png`])
.then(res => res.generateAsync({type: `nodebuffer`}))
.then(buffer => {
 
})
 
// async/await
(async ()=>{
    const jszip = await dtz(src,[`foo.png`]);
    const stream = res.generateNodeStream()
})()
 
// callback
dtz(src,[`foo.png`],(err,res)=>{
    if(err){
        console.log(err);
    }else{
        console.log(res);
    }
})
 
// save to disk
dtz(src,[`foo.png`],`./bar.zip`) // rename
.then(() => console.log(`done`))
 
dtz(src,[`foo.png`],true); // "./app.zip"
 

API

dtz(src[, ignores, callback | outFile])

ignores

pass to recursive-readdir as second arg.

outFile

When true, zip will be generated next to src.

res

instance of jszip.

License

MIT (http://opensource.org/licenses/MIT)

install

npm i dtz

Downloadsweekly downloads

21

version

1.0.2

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability