# pump-dir

> copy dir from node

Latest version **0.0.0** (published 2018-02-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install pump-dir
pnpm add pump-dir
yarn add pump-dir
bun add pump-dir
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.0 |
| Published | 2018-02-15 |
| First published | 2018-02-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 4.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Noah Anabiik Schwarz |
| Maintainers | chiefbiiko |
| Keywords | copy, directory |

## Links

- npm: https://www.npmjs.com/package/pump-dir
- Repository: https://github.com/chiefbiiko/pump-dir
- Homepage: https://github.com/chiefbiiko/pump-dir#readme
- Issues: https://github.com/chiefbiiko/pump-dir/issues
- npm.io page: https://npm.io/package/pump-dir

## Dependencies (2)

- [pump](https://npm.io/package/pump.md) ^3.0.0
- [tar-fs](https://npm.io/package/tar-fs.md) ^1.16.0

## Recent versions

- 0.0.0 (latest) — 2018-02-15

## README

# pump-dir

[![build status](http://img.shields.io/travis/chiefbiiko/pump-dir.svg?style=flat)](http://travis-ci.org/chiefbiiko/pump-dir) [![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/chiefbiiko/pump-dir?branch=master&svg=true)](https://ci.appveyor.com/project/chiefbiiko/pump-dir)

***

Copy entire directories, safely. All work is done by [`pump`](https://github.com/mafintosh/pump) and [`tar-fs`](https://github.com/mafintosh/tar-fs). Thanks 2 [mafintosh](https://github.com/mafintosh).

***

## Get it!

```
npm install --save pump-dir
```

***

## Usage

``` js
var pumpDir = require('pump-dir')

pumpDir('./node_modules', 'clone_modules', function (err) {
  if (err) return console.error(err)
  console.log('cloned node_modules')
})
```

***

## API

### `pumpDir(from, to[, opts], callback)`

Copy a directory. `opts.ignore` can be a predicate method by which all entries will be filtered. Must return `true` for files that shall be excluded, sig `opts.ignore(name, headers)`, see [`tar-fs`](https://github.com/mafintosh/tar-fs). Calling back like `callback(err)`.

***

## License

[MIT](./license.md)

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