summaryrefslogtreecommitdiff
path: root/cli/js/chmod.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/chmod.ts
parent809019dc6e9a80843affc927fa7a52cd41e76471 (diff)
Cleanup comments and internal variables (#4205)
Diffstat (limited to 'cli/js/chmod.ts')
-rw-r--r--cli/js/chmod.ts11
1 files changed, 7 insertions, 4 deletions
diff --git a/cli/js/chmod.ts b/cli/js/chmod.ts
index 22bd8c40e..5aa4ce7ea 100644
--- a/cli/js/chmod.ts
+++ b/cli/js/chmod.ts
@@ -1,19 +1,22 @@
// Copyright 2018-2020 the Deno authors. All rights reserved. MIT license.
import { sendSync, sendAsync } from "./dispatch_json.ts";
-/** Changes the permission of a specific file/directory of specified path
- * synchronously.
+/** Synchronously changes the permission of a specific file/directory of
+ * specified path. Ignores the process's umask.
*
* Deno.chmodSync("/path/to/file", 0o666);
- */
+ *
+ * Requires `allow-write` permission. */
export function chmodSync(path: string, mode: number): void {
sendSync("op_chmod", { path, mode });
}
/** Changes the permission of a specific file/directory of specified path.
+ * Ignores the process's umask.
*
* await Deno.chmod("/path/to/file", 0o666);
- */
+ *
+ * Requires `allow-write` permission. */
export async function chmod(path: string, mode: number): Promise<void> {
await sendAsync("op_chmod", { path, mode });
}