Comparing version 0.5.1 to 0.5.2
{ | ||
"name": "tar-fs", | ||
"version": "0.5.1", | ||
"version": "0.5.2", | ||
"description": "filesystem bindings for tar-stream", | ||
@@ -5,0 +5,0 @@ "repository": { |
@@ -5,3 +5,5 @@ # tar-fs | ||
npm install tar-fs | ||
``` | ||
npm install tar-fs | ||
``` | ||
@@ -15,10 +17,10 @@ [![build status](https://secure.travis-ci.org/mafintosh/tar-fs.png)](http://travis-ci.org/mafintosh/tar-fs) | ||
``` js | ||
var tar = require('tar-fs'); | ||
var fs = require('fs'); | ||
var tar = require('tar-fs') | ||
var fs = require('fs') | ||
// packing a directory | ||
tar.pack('./my-directory').pipe(fs.createWriteStream('my-tarball.tar')); | ||
tar.pack('./my-directory').pipe(fs.createWriteStream('my-tarball.tar')) | ||
// extracting a directory | ||
fs.createReadStream('my-other-tarball.tar').pipe(tar.extract('./my-other-directory')); | ||
fs.createReadStream('my-other-tarball.tar').pipe(tar.extract('./my-other-directory')) | ||
``` | ||
@@ -30,12 +32,12 @@ | ||
var pack = tar.pack('./my-directory', { | ||
ignore: function(name) { | ||
return path.extname(name) === '.bin'; // ignore .bin files when packing | ||
} | ||
}); | ||
ignore: function(name) { | ||
return path.extname(name) === '.bin' // ignore .bin files when packing | ||
} | ||
}) | ||
var extract = tar.extract('./my-other-directory', { | ||
ignore: function(name) { | ||
return path.extname(name) === '.bin'; // ignore .bin files inside the tarball when extracing | ||
} | ||
}); | ||
ignore: function(name) { | ||
return path.extname(name) === '.bin' // ignore .bin files inside the tarball when extracing | ||
} | ||
}) | ||
``` | ||
@@ -47,14 +49,14 @@ | ||
var pack = tar.pack('./my-directory', { | ||
map: function(header) { | ||
header.name = 'prefixed/'+header.name; | ||
return header; | ||
} | ||
}); | ||
map: function(header) { | ||
header.name = 'prefixed/'+header.name | ||
return header | ||
} | ||
}) | ||
var extract = tar.pack('./my-directory', { | ||
map: function(header) { | ||
header.name = 'another-prefix/'+header.name; | ||
return header; | ||
} | ||
}); | ||
map: function(header) { | ||
header.name = 'another-prefix/'+header.name | ||
return header | ||
} | ||
}) | ||
``` | ||
@@ -66,12 +68,12 @@ | ||
var pack = tar.pack('./my-directory', { | ||
mapStream: function(fileStream) { | ||
return fileStream.pipe(someTransform); | ||
} | ||
}); | ||
mapStream: function(fileStream) { | ||
return fileStream.pipe(someTransform) | ||
} | ||
}) | ||
var extract = tar.extract('./my-directory', { | ||
mapStream: function(fileStream) { | ||
return fileStream.pipe(someTransform); | ||
} | ||
}); | ||
mapStream: function(fileStream) { | ||
return fileStream.pipe(someTransform) | ||
} | ||
}) | ||
``` | ||
@@ -83,5 +85,5 @@ | ||
var extract = tar.extract('./my-directory', { | ||
dmode: 0555, // all dirs and files should be readable | ||
fmode: 0444 | ||
}); | ||
dmode: 0555, // all dirs and files should be readable | ||
fmode: 0444 | ||
}) | ||
``` | ||
@@ -96,3 +98,3 @@ | ||
``` js | ||
tar.pack('source-directory').pipe(tar.extract('dest-directory')); | ||
tar.pack('source-directory').pipe(tar.extract('dest-directory')) | ||
``` | ||
@@ -99,0 +101,0 @@ |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
14243
106
0