npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ya-zip

v0.2.1

Published

Yet another zip utility for packaging and compressing a file or a directory

Downloads

4

Readme

ya-zip

npm version

Yet another zip utility for packaging and compressing a file or a directory

Installation

$ npm install ya-zip

Usage

const { zip, zipAsync, zipSync } = require('ya-zip');

const src = path.resolve(__dirname, 'foo');
const dest = path.resolve(__dirname, 'foo.zip');

zipSync(src, dest);

zip(src, dest, (err) => {
  if (err) throw err;
  console.log('Done!');
});

(async () => {
  await zipAsync(src, dest);
  console.log('Done!');
})();

API

zip(source, destination[, options], callback)

Zip a file or a directory.

  • source <string> Sets the path of a file or a directory to zip.
  • destination <string> Sets the path of the destination file.
  • options <Object> See node-archive ZipOptions
    • comment <string> Sets the zip archive comment.
    • forceLocalTime <boolean> Forces the archive to contain local file times instead of UTC.
    • forceZip64 <boolean> Forces the archive to contain ZIP64 headers.
    • store <boolean> Sets the compression method to STORE.
    • zlib <Object> Passed to zlib to control compression.
  • callback <Function>

zipAsync(source, destination[, options])

Promisified zip.

zipSync(source, destination[, options])

Synchronous zip.

License

MIT

Why not cross-zip?

cross-zip-cli (based on cross-zip) has inconsistent behaviors on different platforms.

$ cross-zip ./src src.zip

This will create a zip file contains a src folder on macOS/Linux (which based on Info-ZIP's zip utility).

> cross-zip .\src src.zip

But this command will create a zip file without a src folder on Windows (which based on .Net API).

Note: ya-zip will not create the redundant folder.

See also