wallet-core/node_modules/gulp-tar/readme.md

49 lines
1018 B
Markdown
Raw Normal View History

2016-10-10 03:43:44 +02:00
# gulp-tar [![Build Status](https://travis-ci.org/sindresorhus/gulp-tar.svg?branch=master)](https://travis-ci.org/sindresorhus/gulp-tar)
> Create [tarball](http://en.wikipedia.org/wiki/Tar_(computing)) from files
## Install
```
$ npm install --save-dev gulp-tar
```
## Usage
```js
const gulp = require('gulp');
const tar = require('gulp-tar');
const gzip = require('gulp-gzip');
gulp.task('default', () =>
gulp.src('src/*')
.pipe(tar('archive.tar'))
.pipe(gzip())
.pipe(gulp.dest('dist'))
);
```
## API
### tar(filename, [options])
#### filename
Type: `string`
Filename for the output tar archive.
#### options
2017-08-14 05:01:11 +02:00
Type: `Object`
2016-10-10 03:43:44 +02:00
2017-08-14 05:01:11 +02:00
Default options passed to [Archiver](https://github.com/archiverjs/node-archiver)'s [constructor](https://archiverjs.com/docs/Archiver.html) and merged into the [data](https://archiverjs.com/docs/global.html#TarEntryData) passed to its [`append`](https://archiverjs.com/docs/Archiver.html#append) method.
2016-10-10 03:43:44 +02:00
## License
MIT © [Sindre Sorhus](https://sindresorhus.com)