npm

Need private packages and team management tools?Check out npm Orgs. »

cpy

7.3.0 • Public • Published

cpy Build Status

Copy files

Why

  • Fast by using streams.
  • Resilient by using graceful-fs.
  • User-friendly by accepting globs and creating non-existent destination directories.
  • User-friendly error messages.
  • Progress reporting.

Install

$ npm install cpy

Usage

const cpy = require('cpy');
 
(async () => {
    await cpy(['source/*.png', '!source/goat.png'], 'destination');
    console.log('Files copied!');
})();

API

cpy(source, destination, options?)

Returns a Promise<string[]> with the destination file paths.

source

Type: string | string[]

Files to copy.

destination

Type: string

Destination directory.

options

Type: object

Options are passed to globby.

In addition, you can specify the below options.

cwd

Type: string
Default: process.cwd()

Working directory to find source files.

overwrite

Type: boolean
Default: true

Overwrite existing files.

parents

Type: boolean
Default: false

Preserve path structure.

rename

Type: string | Function

Filename or function returning a filename used to rename every file in source.

cpy('foo.js', 'destination', {
    rename: basename => `prefix-${basename}`
});

Progress reporting

cpy.on('progress', handler)

handler(progress)

Type: Function

progress
{
    completedFiles: number,
    totalFiles: number,
    completedSize: number
}
  • completedSize is in bytes
  • percent is a value between 0 and 1

Note that the .on() method is available only right after the initial cpy call, so make sure you add a handler before awaiting the promise:

(async () => {
    await cpy(source, destination).on('progress', progress => {
        // …
    });
})();

Related

install

npm i cpy

Downloadsweekly downloads

113,663

version

7.3.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability