Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CopyOptions

Copy options based on fs-extra copy options.

Hierarchy

  • CopyOptions

Index

Properties

Optional dereference

dereference: undefined | false | true

Dereference symlinks, default is false.

Optional errorOnExist

errorOnExist: undefined | false | true

When overwrite is false and the destination exists, throw an error. Default is false.

Optional excludeDirFromReturn

excludeDirFromReturn: undefined | false | true

Whether to exclude directories from return value. If this is true only paths of copied files returned but not directories.

Optional filter

Function to filter copied files. Return true to include, false to exclude. Can also return a Promise that resolves to true or false (or pass in an async function)

Optional overwrite

overwrite: undefined | false | true

Overwrite existing file or directory, default is 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.

Optional preserveTimestamps

preserveTimestamps: undefined | false | true

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

Optional recursive

recursive: undefined | false | true

fs-extra.copy recursive option.

Generated using TypeDoc