@types/tar

What is @types/tar?

@types/tar provides TypeScript type definitions for the 'tar' npm package, which is used for creating and extracting tar archives.

What are @types/tar's main functionalities?

Creating a tar archive

This feature allows you to create a tar archive from a list of files and directories. The example code creates a gzip-compressed tar archive named 'archive.tar.gz' containing 'file1', 'file2', and 'directory'.

const tar = require('tar');
tar.c({
  gzip: true,
  file: 'archive.tar.gz'
}, ['file1', 'file2', 'directory']).then(() => {
  console.log('Archive created successfully');
});

Extracting a tar archive

This feature allows you to extract a tar archive to a specified directory. The example code extracts 'archive.tar.gz' into the 'output_directory'.

const tar = require('tar');
tar.x({
  file: 'archive.tar.gz',
  C: 'output_directory'
}).then(() => {
  console.log('Archive extracted successfully');
});

Listing files in a tar archive

This feature allows you to list the files contained in a tar archive. The example code lists the files in 'archive.tar.gz'.

const tar = require('tar');
tar.t({
  file: 'archive.tar.gz'
}).then((list) => {
  console.log('Files in archive:', list);
});

Other packages similar to @types/tar

node-tar

node-tar is the core package for handling tar archives in Node.js. It provides functionalities for creating, extracting, and listing tar archives. @types/tar provides TypeScript definitions for this package.

tar-stream

tar-stream is a lower-level package for creating and extracting tar streams. It provides more granular control over the tar archive creation and extraction process compared to node-tar.

yauzl

yauzl is a package for handling zip archives, which is a different format from tar. It provides functionalities for reading and extracting zip files, similar to what node-tar does for tar files.

README

Installation

npm install --save @types/tar

Summary

This package contains type definitions for tar (https://github.com/npm/node-tar).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/tar.

Additional Details

• Last updated: Fri, 10 Nov 2023 22:24:49 GMT
• Dependencies: @types/node, minipass

Credits

These definitions were written by Maxime LUCE, and Connor Peet.