From 0b4f73cf9d6e7674c76126fc9d37defb58e7a433 Mon Sep 17 00:00:00 2001 From: Vincent LE GOFF Date: Thu, 14 Mar 2019 15:24:54 +0100 Subject: Improve jsdoc (denoland/deno_std#277) Original: https://github.com/denoland/deno_std/commit/1805c18ac7ed3aa6727f509ee2ec55f718ff2f61 --- fs/read_json.ts | 14 ++------------ 1 file changed, 2 insertions(+), 12 deletions(-) (limited to 'fs/read_json.ts') 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} - */ +/** Reads a JSON file and then parses it into an object */ export async function readJson(filePath: string): Promise { filePath = path.resolve(filePath); const decoder = new TextDecoder("utf-8"); @@ -21,12 +16,7 @@ export async function readJson(filePath: string): Promise { } } -/** - * 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"); -- cgit v1.2.3