@hexatool/fs-copy v0.0.1-next.4

Installation

npm install --save @hexatool/fs-copy

Using yarn

yarn add @hexatool/fs-copy

What it does

Copy a file or directory. The directory can have contents.

API

copy(src: string, dest: string, options?: CopyOptions): void

• src
  • Type: string.
  • Optional: false.
  • Note: If src is a directory it will copy everything inside of this directory, not the entire directory itself.

• dest.
  • Type: string.
  • Optional: false.
  • Note: If src is a file, dest cannot be a directory.

• options.
  • Type: CopyOptions.
  • Optional: true.

CopyOptions

• dereference. Dereference symlinks.
  • Type: boolean.
  • Optional: true.
  • Default false.

• filter. Function to filter copied files/directories. Return true to copy the item, false to ignore it.
  • Type: (src: string, dest: string) => boolean.
  • Optional: true.

• errorOnExist. When overwrite is false and the destination exists, throw an error.
  • Type: boolean.
  • Optional: true.
  • Default false.

• overwrite. Overwrite existing file or directory.

  • Type: boolean.
  • Optional: true.
  • Default true.

  Note that the copy operation will silently fail if you set this to false and the destination exists. Use the errorOnExist option to change this behavior.

• preserveTimestamps. When true, will set last modification and access times to the ones of the original source files. When false, timestamp behavior is OS-dependent.
  • Type: boolean.
  • Optional: true.
  • Default false.

Example

import copy from '@hexatool/fs-copy';

// copy file
copy('/tmp/myfile', '/tmp/mynewfile');

// copy directory, even if it has subdirectories or files
copy('/tmp/mydir', '/tmp/mynewdir');

Using filter function

import copy from '@hexatool/fs-copy';

const filterFunc = (src: string, dest: string): boolean => {
  // your logic here
  // it will be copied if return true
}

copy('/tmp/mydir', '/tmp/mynewdir', { filter: filterFunc })

Async function

import copy from '@hexatool/fs-copy/async';

// copy file
await copy('/tmp/myfile', '/tmp/mynewfile');

// copy directory, even if it has subdirectories or files
await copy('/tmp/mydir', '/tmp/mynewdir');

Hexatool Code Quality Standards

Publishing this package we are committing ourselves to the following code quality standards:

• Respect Semantic Versioning: No breaking changes in patch or minor versions
• No surprises in transitive dependencies: Use the bare minimum dependencies needed to meet the purpose
• One specific purpose to meet without having to carry a bunch of unnecessary other utilities
• Tests as documentation and usage examples
• Well documented README showing how to install and use
• License favoring Open Source and collaboration