DefinitelyTyped/types/tar/tar-tests.ts

/**
 * Test suite created by Maxime LUCE <https://github.com/SomaticIT>
 *
 * Created by using code samples from https://github.com/npm/node-tar.
 */

import tar = require("tar");
import fs = require("fs");

/**
 * Quick Extract
 */
fs.createReadStream("path/to/file.tar").pipe(tar.Extract("path/to/extract"));

/**
 * Use with events
 */
const readStream = fs.createReadStream("/path/to/file.tar");
const extract = tar.Extract("/path/to/target");

readStream.pipe(extract);

extract.on("entry", (entry: any) => undefined);

let packStream: tar.PackStream = tar.Pack();
packStream = tar.Pack({ path: 'test' });

/**
 * Examples from tar docs:
 */

tar.c(
    {
        gzip: true,
        file: 'my-tarball.tgz'
    },
    ['some', 'files', 'and', 'folders']
).then(() => undefined);

tar.c(
    {
        gzip: true,
    },
    ['some', 'files', 'and', 'folders']
).pipe(fs.createWriteStream('my-tarball.tgz'));

tar.c(
    {
        prefix: 'some-prefix',
    },
    ['some', 'files', 'and', 'folders']
).pipe(fs.createWriteStream('my-tarball.tgz'));

tar.x(
    {
        file: 'my-tarball.tgz',
    }
).then(() => undefined);

fs.createReadStream('my-tarball.tgz').pipe(
    tar.x({
        strip: 1,
        C: 'some-dir' // alias for cwd:'some-dir', also ok
    })
);

tar.t({
    file: 'my-tarball.tgz',
    onentry: (entry) => console.log(entry.path, 'was', entry.size),
});

fs.createReadStream('my-tarball.tgz')
    .pipe(tar.t())
    .on('entry', entry => console.log(entry.size));