Function ensureSymlinkSync

  • Synchronously ensures that the link exists, and points to a valid file.

    If the parent directories for the link do not exist, they are created. If the link already exists, and it is not modified, this function does nothing. If the link already exists, and it does not point to the given target, an error is thrown.

    Requires --allow-read and --allow-write permissions.

    Parameters

    • target: string | URL

      The source file path as a string or URL. If it is a relative path string, it have to be relative to the link path.

    • linkName: string | URL

      The destination link path as a string or URL.

    Returns void

    A void value that returns once the link exists.

    https://docs.deno.com/runtime/manual/basics/permissions#file-system-access for more information on Deno's permissions system.

    import { ensureSymlinkSync } from "@std/fs/ensure-symlink";

    // Ensures the link `./targetFile.link.dat` exists and points to `./targetFile.dat`
    ensureSymlinkSync("./targetFile.dat", "./targetFile.link.dat");