tar-fs
filesystem bindings for tar-stream.
npm install tar-fs
![build status](https://secure.travis-ci.org/mafintosh/tar-fs.png)
Usage
tar-fs allows you to pack directories into tarballs and extract tarballs into directories.
var tar = require('tar-fs')
var fs = require('fs')
tar.pack('./my-directory').pipe(fs.createWriteStream('my-tarball.tar'))
fs.createReadStream('my-other-tarball.tar').pipe(tar.extract('./my-other-directory'))
To ignore various files when packing or extracting add a ignore function to the options
var pack = tar.pack('./my-directory', {
ignore: function(name) {
return path.extname(name) === '.bin'
}
})
var extract = tar.extract('./my-other-directory', {
ignore: function(name) {
return path.extname(name) === '.bin'
}
})
You can also specify which entries to pack using the entries
option
var pack = tar.pack('./my-directory', {
entries: ['file1', 'subdir/file2']
})
If you want to modify the headers when packing/extracting add a map function to the options
var pack = tar.pack('./my-directory', {
map: function(header) {
header.name = 'prefixed/'+header.name
return header
}
})
var extract = tar.extract('./my-directory', {
map: function(header) {
header.name = 'another-prefix/'+header.name
return header
}
})
Similarly you can use mapStream
incase you wanna modify the input/output file streams
var pack = tar.pack('./my-directory', {
mapStream: function(fileStream, header) {
if (path.extname(header.file) === '.js') {
return fileStream.pipe(someTransform)
}
return fileStream;
}
})
var extract = tar.extract('./my-directory', {
mapStream: function(fileStream, header) {
if (path.extname(header.file) === '.js') {
return fileStream.pipe(someTransform)
}
return fileStream;
}
})
Set options.fmode
and options.dmode
to ensure that files/directories extracted have the corresponding modes
var extract = tar.extract('./my-directory', {
dmode: 0555,
fmode: 0444
})
It can be useful to use dmode
and fmode
if you are packing/unpacking tarballs between *nix/windows to ensure that all files/directories unpacked are readable.
Set options.strict
to false
if you want to ignore errors due to unsupported entry types (like device files)
Copy a directory
Copying a directory with permissions and mtime intact is as simple as
tar.pack('source-directory').pipe(tar.extract('dest-directory'))
Performance
Packing and extracting a 6.1 GB with 2496 directories and 2398 files yields the following results on my Macbook Air.
See the benchmark here
- tar-fs: 34.261 ms
- node-tar: 366.123 ms (or 10x slower)
License
MIT