Skip to content
This repository has been archived by the owner on Apr 12, 2020. It is now read-only.

xeitodevs/fs-safe-copy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.