summaryrefslogtreecommitdiff
path: root/js/read_link.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_link.ts
parent1840a1971317f5b8fc6e322b3a414b7f8a593c88 (diff)
Align JSDoc to style guide.
Diffstat (limited to 'js/read_link.ts')
-rw-r--r--js/read_link.ts14
1 files changed, 6 insertions, 8 deletions
diff --git a/js/read_link.ts b/js/read_link.ts
index bb1988a51..4a5563034 100644
--- a/js/read_link.ts
+++ b/js/read_link.ts
@@ -4,21 +4,19 @@ import { flatbuffers } from "flatbuffers";
import { assert } from "./util";
import * as dispatch from "./dispatch";
-/**
- * Returns the destination of the named symbolic link synchronously.
+/** Returns the destination of the named symbolic link synchronously.
*
- * import { readlinkSync } from "deno";
- * const targetPath = readlinkSync("symlink/path");
+ * import { readlinkSync } from "deno";
+ * const targetPath = readlinkSync("symlink/path");
*/
export function readlinkSync(name: string): string {
return res(dispatch.sendSync(...req(name)));
}
-/**
- * Returns the destination of the named symbolic link.
+/** Returns the destination of the named symbolic link.
*
- * import { readlink } from "deno";
- * const targetPath = await readlink("symlink/path");
+ * import { readlink } from "deno";
+ * const targetPath = await readlink("symlink/path");
*/
export async function readlink(name: string): Promise<string> {
return res(await dispatch.sendAsync(...req(name)));