Interface CopyOptions

interface CopyOptions {
    dereference?: boolean;
    errorOnExist?: boolean;
    force?: boolean;
    mode?: number;
    preserveTimestamps?: boolean;
    recursive?: boolean;
    verbatimSymlinks?: boolean;
    filter?(source, destination): boolean | Promise<boolean>;
}

Hierarchy (view full)

Properties

dereference? errorOnExist? force? mode? preserveTimestamps? recursive? verbatimSymlinks?

Methods

filter?

Properties

Optional dereference

dereference?: boolean

Dereference symlinks

Default

false

Optional errorOnExist

errorOnExist?: boolean

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

Default

false

Optional force

force?: boolean

Overwrite existing file or directory. _The copy operation will ignore errors if you set this to false and the destination exists. Use the errorOnExist option to change this behavior.

Default

true

Optional mode

mode?: number

Modifiers for copy operation. See mode flag of ()

Optional preserveTimestamps

preserveTimestamps?: boolean

When true timestamps from src will be preserved.

Default

false

Optional recursive

recursive?: boolean

Copy directories recursively.

Default

false

Optional verbatimSymlinks

verbatimSymlinks?: boolean

When true, path resolution for symlinks will be skipped

Default

false

Methods

Optional filter

  • filter(source, destination): boolean | Promise<boolean>

  • Function to filter copied files/directories. Return true to copy the item, false to ignore it.

    Parameters

    • source: string
    • destination: string

    Returns boolean | Promise<boolean>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc