summaryrefslogtreecommitdiff
path: root/fs/read_json.ts
diff options
context:
space:
mode:
authorVincent LE GOFF <g_n_s@hotmail.fr>2019-03-14 15:24:54 +0100
committerRyan Dahl <ry@tinyclouds.org>2019-03-14 10:24:54 -0400
commit0b4f73cf9d6e7674c76126fc9d37defb58e7a433 (patch)
treea7f47f908cf81ea36771b537fe043d3ed17bfc34 /fs/read_json.ts
parenta391660d2d539e3ca71418604e34df6c50dd6502 (diff)
Improve jsdoc (denoland/deno_std#277)
Original: https://github.com/denoland/deno_std/commit/1805c18ac7ed3aa6727f509ee2ec55f718ff2f61
Diffstat (limited to 'fs/read_json.ts')
-rw-r--r--fs/read_json.ts14
1 files changed, 2 insertions, 12 deletions
diff --git a/fs/read_json.ts b/fs/read_json.ts
index d5c639ae2..1bed75078 100644
--- a/fs/read_json.ts
+++ b/fs/read_json.ts
@@ -1,12 +1,7 @@
// Copyright 2018-2019 the Deno authors. All rights reserved. MIT license.
import * as path from "./path/mod.ts";
-/**
- * Reads a JSON file and then parses it into an object
- * @export
- * @param {string} filePath
- * @returns {Promise<any>}
- */
+/** Reads a JSON file and then parses it into an object */
export async function readJson(filePath: string): Promise<any> {
filePath = path.resolve(filePath);
const decoder = new TextDecoder("utf-8");
@@ -21,12 +16,7 @@ export async function readJson(filePath: string): Promise<any> {
}
}
-/**
- * Reads a JSON file and then parses it into an object
- * @export
- * @param {string} filePath
- * @returns {void}
- */
+/** Reads a JSON file and then parses it into an object */
export function readJsonSync(filePath: string): any {
filePath = path.resolve(filePath);
const decoder = new TextDecoder("utf-8");