summaryrefslogtreecommitdiff
path: root/js/read_dir.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/read_dir.ts
parent1840a1971317f5b8fc6e322b3a414b7f8a593c88 (diff)
Align JSDoc to style guide.
Diffstat (limited to 'js/read_dir.ts')
-rw-r--r--js/read_dir.ts17
1 files changed, 7 insertions, 10 deletions
diff --git a/js/read_dir.ts b/js/read_dir.ts
index d99b085ec..6be89d6b5 100644
--- a/js/read_dir.ts
+++ b/js/read_dir.ts
@@ -5,23 +5,20 @@ import * as dispatch from "./dispatch";
import { FileInfo, FileInfoImpl } from "./file_info";
import { assert } from "./util";
-/**
- * Reads the directory given by path and returns
- * a list of file info synchronously.
+/** Reads the directory given by path and returns a list of file info
+ * synchronously.
*
- * import { readDirSync } from "deno";
- * const files = readDirSync("/");
+ * import { readDirSync } from "deno";
+ * const files = readDirSync("/");
*/
export function readDirSync(path: string): FileInfo[] {
return res(dispatch.sendSync(...req(path)));
}
-/**
- * Reads the directory given by path and returns a list of file info.
- *
- * import { readDir } from "deno";
- * const files = await readDir("/");
+/** Reads the directory given by path and returns a list of file info.
*
+ * import { readDir } from "deno";
+ * const files = await readDir("/");
*/
export async function readDir(path: string): Promise<FileInfo[]> {
return res(await dispatch.sendAsync(...req(path)));