abi.js
Version:
[![typescript-icon]][typescript-link] [![license-icon]][license-link] [![status-icon]][status-link] [![ci-icon]][ci-link] [![twitter-icon]][twitter-link]
49 lines (48 loc) • 1.71 kB
TypeScript
/**
* Asynchronously ensures that the hard link exists.
*
* If the parent directories for the hard link do not exist, they are created.
*
* Requires `--allow-read` and `--allow-write` permissions.
*
* @see {@link https://docs.deno.com/runtime/manual/basics/permissions#file-system-access}
* for more information on Deno's permissions system.
*
* @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 Usage
* ```ts no-eval
* import { ensureLink } from "@std/fs/ensure-link";
*
* await ensureLink("./folder/targetFile.dat", "./folder/targetFile.link.dat");
* ```
*/
export declare function ensureLink(src: string | URL, dest: string | URL): Promise<void>;
/**
* Synchronously ensures that the hard link exists.
*
* If the parent directories for the hard link do not exist, they are created.
*
* Requires `--allow-read` and `--allow-write` permissions.
*
* @see {@link https://docs.deno.com/runtime/manual/basics/permissions#file-system-access}
* for more information on Deno's permissions system.
*
* @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 Usage
* ```ts no-eval
* import { ensureLinkSync } from "@std/fs/ensure-link";
*
* ensureLinkSync("./folder/targetFile.dat", "./folder/targetFile.link.dat");
* ```
*/
export declare function ensureLinkSync(src: string | URL, dest: string | URL): void;