Rush StackShopBlogEvents
Skip to main content

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

IFileSystemCreateLinkOptions interface

The options for FileSystem.createSymbolicLinkJunction(), FileSystem.createSymbolicLinkFile(), FileSystem.createSymbolicLinkFolder(), and FileSystem.createHardLink().

Signature:

export interface IFileSystemCreateLinkOptions 

Properties

PropertyModifiersTypeDescription
alreadyExistsBehavior?AlreadyExistsBehavior(Optional) Specifies what to do if the path to create already exists. The default is AlreadyExistsBehavior.Error.
linkTargetPathstringThe newly created symbolic link will point to linkTargetPath as its target.
newLinkPathstringThe newly created symbolic link will have this path.