Deno/std
1
0
Fork 0
mirror of https://github.com/denoland/std.git synced 2024-11-21 20:50:22 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

improve docs, add examples

Browse Source
This commit is contained in:
Yoshiya Hinosawa 2024-11-21 12:47:39 +09:00
parent a9197cd9d9
commit 2084f0c049
No known key found for this signature in database
GPG Key ID: 9017DB4559488785
1 changed files with 22 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
fs/ensure_symlink.ts
View File

@ -41,11 +41,20 @@ function getSymlinkOption(
*
* @returns A void promise that resolves once the link exists.
*
* @example Usage
* @example Basic usage
* ```ts ignore
* import { ensureSymlink } from "@std/fs/ensure-symlink";
*
* await ensureSymlink("./folder/targetFile.dat", "./folder/targetFile.link.dat");
* // Ensures the link `./targetFile.link.dat` exists and points to `./targetFile.dat`
* await ensureSymlink("./targetFile.dat", "./targetFile.link.dat");
* ```
*
* @example Ensuring a link in a folder
* ```ts ignore
* import { ensureSymlink } from "@std/fs/ensure-symlink";
*
* // Ensures the link `./folder/targetFile.link.dat` exists and points to `./folder/targetFile.dat`
* await ensureSymlink("./targetFile.dat", "./folder/targetFile.link.dat");
* ```
*/
export async function ensureSymlink(
@ -110,11 +119,20 @@ export async function ensureSymlink(
* @param linkName The destination link path as a string or URL.
* @returns A void value that returns once the link exists.
*
* @example Usage
* @example Basic usage
* ```ts ignore
* import { ensureSymlinkSync } from "@std/fs/ensure-symlink";
*
* ensureSymlinkSync("./folder/targetFile.dat", "./folder/targetFile.link.dat");
* // Ensures the link `./targetFile.link.dat` exists and points to `./targetFile.dat`
* ensureSymlinkSync("./targetFile.dat", "./targetFile.link.dat");
* ```
*
* @example Ensuring a link in a folder
* ```ts ignore
* import { ensureSymlinkSync } from "@std/fs/ensure-symlink";
*
* // Ensures the link `./folder/targetFile.link.dat` exists and points to `./folder/targetFile.dat`
* ensureSymlinkSync("./targetFile.dat", "./folder/targetFile.link.dat");
* ```
*/
export function ensureSymlinkSync(