symlink

Crée un lien symbolique.

Exemple

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" });

Syntaxe

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

Paramètres

• oldPath : chemin cible du lien.
• newPath : chemin du lien a créer.
• params.type : type du lien (Windows uniquement).

Valeur de retour

• E.Ok : si la création réussit.
• FileSystemLeft<"symlink"> : si la création échoue.

Notes

• Sur Windows, type peut etre "file", "dir" ou "junction".

Voir aussi

• readLink - Lit la cible d'un lien symbolique.
• link - Crée un lien physique.