blob: 5bcc82cd89856798c8476a08fe1f71f9362a81d2 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
|
# node-tar
Tar for Node.js.
[![NPM](https://nodei.co/npm/tar.png)](https://nodei.co/npm/tar/)
## 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](https://npmjs.org/package/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:
```js
{
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`.
|