# @stgdp/gulp-archiver

> Create archives from files

Latest version **1.0.0** (published 2022-06-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install @stgdp/gulp-archiver
pnpm add @stgdp/gulp-archiver
yarn add @stgdp/gulp-archiver
bun add @stgdp/gulp-archiver
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2022-06-01 |
| First published | 2022-06-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=12 |
| Dependencies | 3 |
| Unpacked size | 4.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Andrew Palfrey |
| Maintainers | apalfrey |
| Keywords | gulpplugin, archive, archiver, compress, compression, file, files, stream, streams |

## Links

- npm: https://www.npmjs.com/package/@stgdp/gulp-archiver
- Repository: https://github.com/stgdp/gulp-archiver
- Issues: https://github.com/stgdp/gulp-archiver/issues
- npm.io page: https://npm.io/package/@stgdp/gulp-archiver

## Dependencies (3)

- [vinyl](https://npm.io/package/vinyl.md) ^2.2.1
- [archiver](https://npm.io/package/archiver.md) ^5.3.1
- [through2](https://npm.io/package/through2.md) ^4.0.2

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 1.0.0 (latest) — 2022-06-01

## README

# @stgdp/gulp-archiver
## Adapted from [gulp-tar](https://github.com/sindresorhus/gulp-tar)
> Create archives from files


## Install

```
$ npm install --save-dev @stgdp/gulp-archiver
```


## Usage

```js
const gulp = require( 'gulp' )
const archiver = require( '@stgdp/gulp-archiver' )
const gzip = require( 'gulp-gzip' )

exports.default = () => (
	gulp.src( 'src/*' )
		.pipe( archiver( 'archive.tar' ) )
		.pipe( gzip() )
		.pipe( gulp.dest( 'dist' ) )
)
```


## API

### archiver(filename, format, options?)

#### filename

Type: `string`

Filename for the output archive.

#### format

Type: `string`

Format for the output tar archive. Can be `zip`, `tar` or `json`

#### options

Type: `object`

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.

---
_Source: https://npm.io/package/@stgdp/gulp-archiver · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
