Skip to main content
Using Deno in production at your company? Earn free Deno merch.
Give us feedback
Module

std/fs/ensure_link.ts

The Deno Standard Library
Latest
File
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.import { dirname } from "../path/dirname.ts";import { ensureDir, ensureDirSync } from "./ensure_dir.ts";import { toPathString } from "./_to_path_string.ts";
/** * Asynchronously ensures that the hard link exists. If the directory structure * does not exist, it is created. * * @param src The source file path as a string or URL. Directory hard links are * not allowed. * @param dest The destination link path as a string or URL. * @returns A void promise that resolves once the hard link exists. * * @example * ```ts * import { ensureLink } from "https://deno.land/std@$STD_VERSION/fs/ensure_link.ts"; * * await ensureLink("./folder/targetFile.dat", "./folder/targetFile.link.dat"); * ``` */export async function ensureLink(src: string | URL, dest: string | URL) { dest = toPathString(dest); await ensureDir(dirname(dest));
await Deno.link(toPathString(src), dest);}
/** * Synchronously ensures that the hard link exists. If the directory structure * does not exist, it is created. * * @param src The source file path as a string or URL. Directory hard links are * not allowed. * @param dest The destination link path as a string or URL. * @returns A void value that returns once the hard link exists. * * @example * ```ts * import { ensureLinkSync } from "https://deno.land/std@$STD_VERSION/fs/ensure_link.ts"; * * ensureLinkSync("./folder/targetFile.dat", "./folder/targetFile.link.dat"); * ``` */export function ensureLinkSync(src: string | URL, dest: string | URL) { dest = toPathString(dest); ensureDirSync(dirname(dest));
Deno.linkSync(toPathString(src), dest);}