@types/tar-stream

What is @types/tar-stream?

@types/tar-stream provides TypeScript type definitions for the tar-stream package, which is a streaming tar parser and generator. It allows you to create and extract tar archives in a streaming fashion, making it suitable for handling large files or integrating with other streaming APIs.

What are @types/tar-stream's main functionalities?

Creating a tar archive

This feature allows you to create a tar archive by adding entries to it. The example demonstrates how to create a tarball with a single file named 'my-file.txt' containing the text 'Hello, world!'.

const tar = require('tar-stream');
const pack = tar.pack();
const fs = require('fs');

pack.entry({ name: 'my-file.txt' }, 'Hello, world!');
pack.finalize();

pack.pipe(fs.createWriteStream('my-tarball.tar'));

Extracting a tar archive

This feature allows you to extract files from a tar archive. The example demonstrates how to read a tarball and handle each entry as it is extracted.

const tar = require('tar-stream');
const extract = tar.extract();
const fs = require('fs');

extract.on('entry', function(header, stream, next) {
  stream.on('end', next);
  stream.resume();
});

fs.createReadStream('my-tarball.tar').pipe(extract);

Appending files to an existing tar archive

This feature allows you to append new files to an existing tar archive. The example demonstrates how to read an existing tarball, add a new file to it, and write the updated tarball to a new file.

const tar = require('tar-stream');
const fs = require('fs');
const pack = tar.pack();

pack.entry({ name: 'new-file.txt' }, 'New content');
pack.finalize();

const extract = tar.extract();
extract.on('entry', function(header, stream, next) {
  pack.entry(header, function(err, entry) {
    stream.pipe(entry);
    stream.on('end', next);
  });
});

fs.createReadStream('existing-tarball.tar').pipe(extract);
pack.pipe(fs.createWriteStream('updated-tarball.tar'));

Other packages similar to @types/tar-stream

tar

The 'tar' package provides high-level APIs for creating and extracting tar archives. It is more user-friendly and offers additional features like compression support. However, it may not be as efficient for streaming large files as tar-stream.

node-tar

The 'node-tar' package is another popular library for working with tar archives. It provides both high-level and low-level APIs, making it versatile for different use cases. Compared to tar-stream, it offers more built-in utilities but may not be as lightweight.

archiver

The 'archiver' package is a general-purpose archive generation library that supports various formats, including tar. It provides a simple API for creating archives and supports compression. While it is more versatile, it may not be as specialized for tar archives as tar-stream.

README

Installation

npm install --save @types/tar-stream

Summary

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

Details

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

Additional Details

• Last updated: Mon, 03 Jun 2019 23:37:26 GMT
• Dependencies: @types/node
• Global values: none

Credits

These definitions were written by Guy Lichtman https://github.com/glicht.