Skip to content
This repository

tar for node

v0.1.19

latest commit 52ac1201ac
Isaac Z. Schlueter authored
Octocat-spinner-32 examples s/Reader/Parse
Octocat-spinner-32 lib Use new inherits
Octocat-spinner-32 test remove engines constraint
Octocat-spinner-32 .gitignore Ignore test/fixtures/ folder
Octocat-spinner-32 .travis.yml travis-ci
Octocat-spinner-32 LICENCE bsd lic
Octocat-spinner-32 README.md remove diatribe, format readme
Octocat-spinner-32 package.json v0.1.19
Octocat-spinner-32 tar.js Fix #15: Treat '' as OldFile
README.md

node-tar

Tar for Node.js.

NPM

API

See examples/ for usage examples.

var tar = require('tar')

Returns an object with .Pack, .Extract and .Parse methods.

tar.Pack([properties])

Returns a through stream. Use fstream to write files into the pack stream and you will receive tar archive data from the pack stream.

The optional properties object are used to set properties in the tar 'Global Extended Header'.

tar.Extract([options])

Returns a through stream. Write tar data to the stream and the files in the tarball will be extracted onto the filesystem.

options can be:

{
  path: '/path/to/extract/tar/into',
  strip: 0, // how many path segments to strip from the root when extracting
}

options also get passed to the fstream.Writer instance that tar uses internally.

tar.Parse()

Returns a writable stream. Write tar data to it and it will emit entry events for each entry parsed from the tarball. This is used by tar.Extract.

Something went wrong with that request. Please try again.