summaryrefslogtreecommitdiff
path: root/cli/js/dir.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/dir.ts
parent809019dc6e9a80843affc927fa7a52cd41e76471 (diff)
Cleanup comments and internal variables (#4205)
Diffstat (limited to 'cli/js/dir.ts')
-rw-r--r--cli/js/dir.ts20
1 files changed, 13 insertions, 7 deletions
diff --git a/cli/js/dir.ts b/cli/js/dir.ts
index eea2ef691..bc62be83f 100644
--- a/cli/js/dir.ts
+++ b/cli/js/dir.ts
@@ -2,19 +2,25 @@
import { sendSync } from "./dispatch_json.ts";
/**
- * `cwd()` Return a string representing the current working directory.
- * If the current directory can be reached via multiple paths
- * (due to symbolic links), `cwd()` may return
- * any one of them.
- * throws `NotFound` exception if directory not available
+ * **UNSTABLE**: maybe needs permissions.
+ *
+ * Return a string representing the current working directory.
+ *
+ * If the current directory can be reached via multiple paths (due to symbolic
+ * links), `cwd()` may return any one of them.
+ *
+ * Throws `Deno.errors.NotFound` if directory not available.
*/
export function cwd(): string {
return sendSync("op_cwd");
}
/**
- * `chdir()` Change the current working directory to path.
- * throws `NotFound` exception if directory not available
+ * **UNSTABLE**: maybe needs permissions.
+ *
+ * Change the current working directory to the specified path.
+ *
+ * Throws `Deno.errors.NotFound` if directory not available.
*/
export function chdir(directory: string): void {
sendSync("op_chdir", { directory });