mirror of
https://github.com/denoland/std.git
synced 2024-11-21 20:50:22 +00:00
a6251703f7
* refactor(datetime): rename `_common.ts` to `_date_time_formatter.ts` * docs(fs): polish documentation * work
51 lines
1.7 KiB
TypeScript
51 lines
1.7 KiB
TypeScript
// 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);
|
|
}
|