Giter Club home page Giter Club logo

cpy's Introduction

cpy Build Status

Copy files

Why

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

Install

$ npm install --save cpy

Usage

const cpy = require('cpy');

cpy(['src/*.png', '!src/goat.png'], 'dist').then(() => {
	console.log('files copied');
});

API

cpy(files, destination, [options])

files

Type: string Array

Files to copy.

destination

Type: string

Destination directory.

options

Type: Object

Options are passed to cp-file and glob.

cwd

Type: string
Default: process.cwd()

Working directory to find source 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 files.

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 calling .then():

cpy(src, dst).on('progress', progress => {
	// …
}).then(() => {
	// …
})

Related

  • cpy-cli - CLI for this module
  • cp-file - Copy a single file
  • make-dir - Make a directory and its parents if needed

License

MIT © Sindre Sorhus

cpy's People

Contributors

andrefgneves avatar floatdrop avatar guillaumevincent avatar jamiebuilds avatar kevva avatar ragingwind avatar samverschueren avatar sanemat avatar schnittstabil avatar scrum avatar sindresorhus avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.