Intermodular

# Interface: CopyOptions

Copy options based on fs-extra copy options.

# Hierarchy

  • CopyOptions

# Properties

# Optional dereference

• dereference? : undefined | false | true

Defined in src/util/types.ts:46

Dereference symlinks, default is false.

# Optional errorOnExist

• errorOnExist? : undefined | false | true

Defined in src/util/types.ts:52

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

# Optional excludeDirFromReturn

• excludeDirFromReturn? : undefined | false | true

Defined in src/util/types.ts:58

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

# Optional filter

• filter? : CopyFilterFunction

Defined in src/util/types.ts:54

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

Defined in src/util/types.ts:48

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

Defined in src/util/types.ts:50

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

Defined in src/util/types.ts:56

fs-extra.copy recursive option.

← Interface: ExecuteOptions ‹EncodingType› →