diff options
author | dubiousjim <dubiousjim@gmail.com> | 2020-03-02 10:19:42 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-03-02 10:19:42 -0500 |
commit | 6cd46fa3ef4b12f35a60f1a33c7f038c06b5fc71 (patch) | |
tree | e8ef21a936ebac529a7c8e87681123fbd225ff5f /cli/js/read_link.ts | |
parent | 809019dc6e9a80843affc927fa7a52cd41e76471 (diff) |
Cleanup comments and internal variables (#4205)
Diffstat (limited to 'cli/js/read_link.ts')
-rw-r--r-- | cli/js/read_link.ts | 10 |
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 }); } |