RoadmapShopEvents
Skip to main content

Home > @rushstack/node-core-library > IFileSystemCopyFilesOptions

IFileSystemCopyFilesOptions interface

The options for FileSystem.copyFiles()

Signature:

export interface IFileSystemCopyFilesOptions extends IFileSystemCopyFilesAsyncOptions 

Extends: IFileSystemCopyFilesAsyncOptions

Properties

PropertyModifiersTypeDescription
alreadyExistsBehavior?AlreadyExistsBehavior

(Optional) Specifies what to do if a destination path already exists.

(Inherited from IFileSystemCopyFilesAsyncOptions)

dereferenceSymlinks?boolean

(Optional) If true, then when copying symlinks, copy the target object instead of copying the link.

(Inherited from IFileSystemCopyFilesAsyncOptions)

destinationPathstring

The path that the files will be copied to. The path may be absolute or relative.

(Inherited from IFileSystemCopyFilesAsyncOptions)

filter?FileSystemCopyFilesFilter(Optional) A callback that will be invoked for each path that is copied. The callback can return false to cause the object to be excluded from the operation.
preserveTimestamps?boolean

(Optional) If true, then the target object will be assigned "last modification" and "last access" timestamps that are the same as the source. Otherwise, the OS default timestamps are assigned.

(Inherited from IFileSystemCopyFilesAsyncOptions)

sourcePathstring

The starting path of the file or folder to be copied. The path may be absolute or relative.

(Inherited from IFileSystemCopyFilesAsyncOptions)