Interface SymlinkOptions

Options controlling the behavior of methods involving symlink operations.

Hierarchy

Properties

interpRelativeSource?: "cwd" | "path"

How to interpret the target/destination of the filepath operation when it is provided as a relative filepath.

  • cwd -- The target is resolved relative to the current working directory.
  • path -- The target is resolved relative to the Path instance which calls the method involving this option.
targetIsLink?: boolean

Whether the filepath indicate in "target" should be treated as a symlink.

  • If true, then the target is treated as the link and the filepath calling the method must be an existing file or directory.
  • If false, then the target must be an existing file or directory and the underlying filepath is the symlink that will be created.
type?: "file" | "dir"

On Windows only, a value of either "file" or "dir" denoting the type of symlink to create. Defaults to undefined, where an inference will be made based on the filepath being linked.

Generated using TypeDoc