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

zip-tar-util

v1.4.4

Published

A package for simplifying file compression and decompression

Downloads

1

Readme

zip-tar-util

A simple Node.js library for compressing and decompressing ZIP and TAR files.

Installation

You can install this package using npm:

npm install zip-tar-util

Usage

compress(sourceDir, destFile, [archiveType])

Compresses a directory into either a zip or tar archive and saves it to the specified destination file.

Parameters:

  • sourceDir - A string representing the path to the source directory.
  • destFile - A string representing the path to the destination archive file.
  • archiveType (optional) - A string representing the type of archive to create. Must be one of the following: 'zip', 'tar' or undefined (defaults to 'zip' if not specified).

Returns:

A Promise that resolves when the archive is created.

Example:

import compress from 'zip-tar-util'

// Compress a directory into a zip file
compress("/path/to/source", "/path/to/target.zip", "zip");

// Compress a directory into a tar file
compress("/path/to/source", "/path/to/target.tar", "tar");

decompress(sourceFile, targetDir)

This function decompresses the source archive file into the target directory.

Parameters:

  • sourceFile - The path to the archive file to decompress.
  • targetDir - The path to the directory where the archive file will be decompressed.

Example:

import decompress from 'zip-tar-util'

// Decompress a zip file into a directory
decompress('/path/to/source.zip', '/path/to/target');

// Decompress a tar file into a directory
decompress('/path/to/source.tar', '/path/to/target');

License

This package is licensed under the MIT License.