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/link.ts | |
parent | 809019dc6e9a80843affc927fa7a52cd41e76471 (diff) |
Cleanup comments and internal variables (#4205)
Diffstat (limited to 'cli/js/link.ts')
-rw-r--r-- | cli/js/link.ts | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/cli/js/link.ts b/cli/js/link.ts index 4d66d1cf9..cd738b1bc 100644 --- a/cli/js/link.ts +++ b/cli/js/link.ts @@ -1,10 +1,11 @@ // Copyright 2018-2020 the Deno authors. All rights reserved. MIT license. import { sendSync, sendAsync } from "./dispatch_json.ts"; -/** Synchronously creates `newname` as a hard link to `oldname`. +/** Creates `newname` as a hard link to `oldname`. * * Deno.linkSync("old/name", "new/name"); - */ + * + * Requires `allow-read` and `allow-write` permissions. */ export function linkSync(oldname: string, newname: string): void { sendSync("op_link", { oldname, newname }); } @@ -12,7 +13,8 @@ export function linkSync(oldname: string, newname: string): void { /** Creates `newname` as a hard link to `oldname`. * * await Deno.link("old/name", "new/name"); - */ + * + * Requires `allow-read` and `allow-write` permissions. */ export async function link(oldname: string, newname: string): Promise<void> { await sendAsync("op_link", { oldname, newname }); } |