summaryrefslogtreecommitdiff
path: root/cli/js/read_link.ts
diff options
context:
space:
mode:
Diffstat (limited to 'cli/js/read_link.ts')
-rw-r--r--cli/js/read_link.ts10
1 files changed, 6 insertions, 4 deletions
diff --git a/cli/js/read_link.ts b/cli/js/read_link.ts
index 5432bedf7..6f43e8867 100644
--- a/cli/js/read_link.ts
+++ b/cli/js/read_link.ts
@@ -1,18 +1,20 @@
// Copyright 2018-2020 the Deno authors. All rights reserved. MIT license.
import { sendSync, sendAsync } from "./dispatch_json.ts";
-/** Returns the destination of the named symbolic link synchronously.
+/** Returns the destination of the named symbolic link.
*
* const targetPath = Deno.readlinkSync("symlink/path");
- */
+ *
+ * Requires `allow-read` permission. */
export function readlinkSync(name: string): string {
return sendSync("op_read_link", { name });
}
-/** Returns the destination of the named symbolic link.
+/** Resolves to the destination of the named symbolic link.
*
* const targetPath = await Deno.readlink("symlink/path");
- */
+ *
+ * Requires `allow-read` permission. */
export async function readlink(name: string): Promise<string> {
return await sendAsync("op_read_link", { name });
}