symlink

Creates a symbolic link.

Example

import { SF } from "@duplojs/server-utils";

const result = await SF.symlink("/tmp/target", "/tmp/link");
// result: E.Ok | SF.FileSystemLeft<"symlink">

await SF.symlink("/tmp/target", "/tmp/link-file", { type: "file" });

Syntax

function symlink(
  oldPath: string,
  newPath: string,
  params?: {
    type: "file" | "dir" | "junction";
  }
): Promise<FileSystemLeft<"symlink"> | E.Ok>

Parameters

• oldPath : link target path.
• newPath : path of the link to create.
• params.type : link type (Windows only).

Return value

• E.Ok : if creation succeeds.
• FileSystemLeft<"symlink"> : if creation fails.

Notes

• On Windows, type can be "file", "dir", or "junction".

See also

• readLink - Reads the target of a symbolic link.
• link - Creates a hard link.