You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 7-8.RSVP
Socket
Socket
Sign inDemoInstall

compress-commons

Package Overview
Dependencies
Maintainers
1
Versions
43
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

compress-commons

a library that defines a common interface for working with archive formats within node


Version published
Maintainers
1
Created

Package description

What is compress-commons?

The compress-commons npm package is a library that provides a set of reusable classes and functions for creating and extracting archive files. It supports various archive formats, making it a versatile tool for handling compression and decompression tasks in Node.js applications.

What are compress-commons's main functionalities?

Creating Archive Files

This feature allows you to create archive files. The code sample demonstrates how to create a TAR archive containing a single file with the content 'Hello World!'.

const fs = require('fs');
const tar = require('compress-commons').tar;
const output = fs.createWriteStream('archive.tar');
const archive = tar.createArchiveStream();
output.on('close', function() {
  console.log('Archive has been finalized.');
});
archive.pipe(output);
archive.entry('file.txt', 'Hello World!', function(err) {
  if (err) throw err;
  archive.finish();
});

Extracting Archive Files

This feature enables the extraction of archive files. The provided code sample shows how to extract files from a TAR archive, handling each entry and completing the process.

const fs = require('fs');
const tar = require('compress-commons').tar;
const input = fs.createReadStream('archive.tar');
const archive = tar.extractArchiveStream();
input.pipe(archive);
archive.on('entry', function(header, stream, next) {
  stream.on('end', next);
  stream.resume();
});
archive.on('finish', function() {
  console.log('Extraction complete.');
});

Other packages similar to compress-commons

Readme

Source

Compress Commons

Compress Commons is a library that defines a common interface for working with archive formats within node.

NPM

Install

npm install compress-commons --save

You can also use npm install https://github.com/archiverjs/node-compress-commons/archive/master.tar.gz to test upcoming versions.

Things of Interest

Credits

Concept inspired by Apache Commons Compress™.

Some logic derived from Apache Commons Compress™ and OpenJDK 7.

Keywords

FAQs

Package last updated on 10 Mar 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc