Code Monkey home page Code Monkey logo

cprf's Introduction

cprf

Build Status Dependency Status devDependency Status

Asynchronously, recursively copy directories and files.

Features

  • Copies broken symlinks
  • Always overwrites destination
  • Automatically creates non-existing directories
  • Strictly programmatic approach
  • Simple usage interface
  • Customizeable copy action
  • Fully asynchronous
  • Uses graceful-fs to retry EMFILE errors
  • Tests!

Installation

npm install cprf

Usage

To copy ./my_source to ./my_destination:

var cprf = require('cprf');

cprf('./my_source', './my_destination', function (err) {
  if (err) throw err;
});

You can also completely customize the copy procedure by listening to the copy event. This allows you to do things like changing destination file names and modifying file contents on copy.

var cprf = require('cprf');
var stream = require('stream');

var makeUpperCase = new stream.Transform();
makeUpperCase._transform = function (chunk, enc, cb) {
  cb(null, chunk.toString().toUpperCase());
};

cprf('./my_source', './my_destination', function (err) {
  if (err) throw err;
}).on('copy', function (stats, src, dest, copy) {
  copy(src, dest, makeUpperCase);
});

The copy event emits the following data:

  • stats - the fs.Stat object resulting from running fs.lstat() on the source;
  • src - the absolute source path;
  • dest - the absolute destination path;
  • copy - a function of signature copy(src, dest, transform). You must call it if you wish to actually perform a copy operation. It takes the following arguments:
    • src - the absolute source path;
    • dest - the absolute destination path;
    • transform - a stream.Transform instance through which the source file contents will be piped before being written to the destination. If the source is not a file, it will be ignored.

Changelog

2.0.1

  • Add ability to customize copy procedure via the copy event.

1.1.0

  • No longer need concurrency limit using graceful-fs

1.0.0

  • Add default/adjustable concurrency limit

0.1.2

  • Fixed/enable file mode duplication

License

Copyright (c) 2014, Aleksey Smolenchuk [email protected]

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

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.