# copy-files

> Streaming file copier

Latest version **0.1.0** (published 2014-06-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install copy-files
pnpm add copy-files
yarn add copy-files
bun add copy-files
```

## 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.1.0 |
| Published | 2014-06-04 |
| First published | 2014-06-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Scott Corgan |
| Maintainers | scottcorgan |
| Keywords | copy, stream, files, copies, mv, cp |

## Links

- npm: https://www.npmjs.com/package/copy-files
- Repository: https://github.com/scottcorgan/copy-files
- Issues: https://github.com/scottcorgan/copy-files/issues
- npm.io page: https://npm.io/package/copy-files

## Dependencies (3)

- [async](https://npm.io/package/async.md) ^0.9.0
- [lodash](https://npm.io/package/lodash.md) ^2.4.1
- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.0

## 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

- 0.1.0 (latest) — 2014-06-04

## README

# copy-files

Streaming file copier

## Install

```
npm install copy-files --save
```

## Usage

```js
var copy = require('copy-files');

copy({
  files: {
    'newname.txt': __dirname + '/path/to/source.txt'
  },
  dest: '/path/to/destination',
}, function (err) {
  // All copied!
});
```

### copy(options, callback)

Async copy method using streams to copy files

#### options

* `files` - list of files to copy. The key is the copied file's name and the value is the file to copy
* `dest` - the destination directory to copy the files to
* `overwrite` - OPTIONAL - flag telling the copy method whether or not to overwrite existing files in `dest` directory. Defaults to *false*.

## Run Tests

```
npm install
npm test
```

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