summaryrefslogtreecommitdiff
path: root/js/remove.ts
diff options
context:
space:
mode:
authorKitson Kelly <me@kitsonkelly.com>2018-10-15 07:29:50 +1100
committerRyan Dahl <ry@tinyclouds.org>2018-10-14 17:38:23 -0400
commit10a97679ac80b4304c75d33cbc59c5736d11deb1 (patch)
treeb51b9183ed251f61373069e5c4d35e39603bedb2 /js/remove.ts
parent1840a1971317f5b8fc6e322b3a414b7f8a593c88 (diff)
Align JSDoc to style guide.
Diffstat (limited to 'js/remove.ts')
-rw-r--r--js/remove.ts38
1 files changed, 16 insertions, 22 deletions
diff --git a/js/remove.ts b/js/remove.ts
index b5619cd49..1195f3a30 100644
--- a/js/remove.ts
+++ b/js/remove.ts
@@ -3,47 +3,41 @@ import * as msg from "gen/msg_generated";
import { flatbuffers } from "flatbuffers";
import * as dispatch from "./dispatch";
-/**
- * Removes the named file or (empty) directory synchronously.
- * Would throw error if permission denied, not found, or
- * directory not empty.
+/** Removes the named file or (empty) directory synchronously. Would throw
+ * error if permission denied, not found, or directory not empty.
*
- * import { removeSync } from "deno";
- * removeSync("/path/to/empty_dir/or/file");
+ * import { removeSync } from "deno";
+ * removeSync("/path/to/empty_dir/or/file");
*/
export function removeSync(path: string): void {
dispatch.sendSync(...req(path, false));
}
-/**
- * Removes the named file or (empty) directory.
- * Would throw error if permission denied, not found, or
- * directory not empty.
+/** Removes the named file or (empty) directory. Would throw error if
+ * permission denied, not found, or directory not empty.
*
- * import { remove } from "deno";
- * await remove("/path/to/empty_dir/or/file");
+ * import { remove } from "deno";
+ * await remove("/path/to/empty_dir/or/file");
*/
export async function remove(path: string): Promise<void> {
await dispatch.sendAsync(...req(path, false));
}
-/**
- * Recursively removes the named file or directory synchronously.
- * Would throw error if permission denied or not found
+/** Recursively removes the named file or directory synchronously. Would throw
+ * error if permission denied or not found.
*
- * import { removeAllSync } from "deno";
- * removeAllSync("/path/to/dir/or/file");
+ * import { removeAllSync } from "deno";
+ * removeAllSync("/path/to/dir/or/file");
*/
export function removeAllSync(path: string): void {
dispatch.sendSync(...req(path, true));
}
-/**
- * Recursively removes the named file or directory.
- * Would throw error if permission denied or not found
+/** Recursively removes the named file or directory. Would throw error if
+ * permission denied or not found.
*
- * import { removeAll } from "deno";
- * await removeAll("/path/to/dir/or/file");
+ * import { removeAll } from "deno";
+ * await removeAll("/path/to/dir/or/file");
*/
export async function removeAll(path: string): Promise<void> {
await dispatch.sendAsync(...req(path, true));