summaryrefslogtreecommitdiff
path: root/cli/js/chown.ts
diff options
context:
space:
mode:
authordubiousjim <dubiousjim@gmail.com>2020-03-02 10:19:42 -0500
committerGitHub <noreply@github.com>2020-03-02 10:19:42 -0500
commit6cd46fa3ef4b12f35a60f1a33c7f038c06b5fc71 (patch)
treee8ef21a936ebac529a7c8e87681123fbd225ff5f /cli/js/chown.ts
parent809019dc6e9a80843affc927fa7a52cd41e76471 (diff)
Cleanup comments and internal variables (#4205)
Diffstat (limited to 'cli/js/chown.ts')
-rw-r--r--cli/js/chown.ts14
1 files changed, 10 insertions, 4 deletions
diff --git a/cli/js/chown.ts b/cli/js/chown.ts
index d56be3dc2..e39741546 100644
--- a/cli/js/chown.ts
+++ b/cli/js/chown.ts
@@ -1,8 +1,11 @@
// Copyright 2018-2020 the Deno authors. All rights reserved. MIT license.
import { sendSync, sendAsync } from "./dispatch_json.ts";
-/**
- * Change owner of a regular file or directory synchronously. Unix only at the moment.
+/** Synchronously change owner of a regular file or directory. Linux/Mac OS
+ * only at the moment.
+ *
+ * Requires `allow-write` permission.
+ *
* @param path path to the file
* @param uid user id of the new owner
* @param gid group id of the new owner
@@ -11,8 +14,11 @@ export function chownSync(path: string, uid: number, gid: number): void {
sendSync("op_chown", { path, uid, gid });
}
-/**
- * Change owner of a regular file or directory asynchronously. Unix only at the moment.
+/** Change owner of a regular file or directory. Linux/Mac OS only at the
+ * moment.
+ *
+ * Requires `allow-write` permission.
+ *
* @param path path to the file
* @param uid user id of the new owner
* @param gid group id of the new owner