copy

copy

Copy files or directories using globs.

Install

Install with npm:

$ npm install copy --save

breaking changes in v0.2.0!

The API has been simplified. Please review the API documentation below to see the new API.

Usage

var copy = require('copy');

Examples

Usage with gulp

In your project's gulpfile.js:

var gulp = require('gulp');
var copy = require('copy');

gulp.task('default', function (cb) {
  copy('fixtures/*.txt', 'actual', cb);
});

API

copy

Copy a filepath, vinyl file, array of files, or glob of files to the given destination directory, with options and callback function that exposes err and the array of vinyl files that are created by the copy operation.

Params

• patterns {String|Object|Array}: Filepath(s), vinyl file(s) or glob of files.
• dir {String}: Destination directory
• options {Object|Function}: or callback function
• cb {Function}: Callback function if no options are specified

Example

copy('*.js', 'dist', function(err, file) {
  // exposes the vinyl `file` created when the file is copied
});

.copy.each

Copy an array of files to the given destination directory, with options and callback function that exposes err and the array of vinyl files that are created by the copy operation.

Params

• files {Array}: Filepaths or vinyl files.
• dir {String}: Destination directory
• options {Object|Function}: or callback function
• cb {Function}: Callback function if no options are specified

Example

copy.each(['foo.txt', 'bar.txt', 'baz.txt'], 'dist', function(err, files) {
  // exposes the vinyl `files` created when the files are copied
});

.copy.one

Copy a single file to the given dest directory, using the specified options and callback function.

Params

• file {String|Object}: Filepath or vinyl file
• dir {String}: Destination directory
• options {Object|Function}: or callback function
• cb {Function}: Callback function if no options are specified

Example

copy.one('foo.txt', 'dist', function(err, file) {
  if (err) throw err;
  // exposes the vinyl `file` that is created when the file is copied
});

Related projects

• expand-config: Expand tasks, targets and files in a declarative configuration. | homepage
• expand-files: Expand glob patterns in a declarative configuration into src-dest mappings. | homepage
• expand-target: Expand target definitions in a declarative configuration. | homepage
• expand-task: Expand and normalize task definitions in a declarative configuration. | homepage
• export-files: node.js utility for exporting a directory of files as modules. | homepage
• write: Write files to disk, creating intermediate directories if they don't exist. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

Generate readme and API documentation with verb:

$ npm install verb && npm run docs

Or, if verb is installed globally:

$ verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2016 Jon Schlinkert Released under the MIT license.

---

This file was generated by verb, v0.9.0, on March 22, 2016.