tarr
tarr for node
Last updated 5 years ago by sintaxi .
BSD · Repository · Bugs · Original npm · Tarball · package.json
$ gnpm install tarr 
SYNC missed versions from official npm registry.

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.

This only works with directories, it does not work with individual files.

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.

Current Tags

  • 1.1.0                                ...           latest (5 years ago)

3 Versions

  • 1.1.0                                ...           5 years ago
  • 1.0.3                                ...           7 years ago
  • 0.1.3                                ...           7 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (3)
Dev Dependencies (4)
Dependents (3)

Copyright 2013 - present © cnpmjs.org | Home |