Code Monkey home page Code Monkey logo

fs-safe-copy's Introduction

fs-safe-copy

Build Status JavaScript Style Guide codecov

A library for copy files with a promise based interface and operation checks utilities.

Features

  • Streams based programming
  • Promise based interface
  • Copy single files
  • Copy directories with files within (only one level of depth)
  • Safe copy function, to verify the copied file when operation finishes

Installation

You can download this package with the blazing fast NPM

npm i fs-safe-copy

Usage

const { copy, safeCopy } = require('fs-safe-copy')

// Only copy one file

try {
    await copy('/origin/file.txt', '/destination/file.txt')
} catch (e){
    // do something. see lib/errors.
}

// Copy entire dir, with depth level 1. (subdirs will be ignored)
await copy('/origin', '/destination')

// Copy one unique file and do the checksum after operation.
try {
    await safeCopy('/origin/file.txt', '/destination/file.txt', 'sha1')
} catch (e) {
     // do something. see lib/errors
}
// Note the third argument above example, you can set the hash algorithm
// to do the checksum of the file after is copied. Defaults to md5.

Authors

See also the list of contributors who participated in this project.

fs-safe-copy's People

Contributors

zucchinidev 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.