From 195e4eaa1892ea1c70512f6b850cd8e6667e460a Mon Sep 17 00:00:00 2001 From: Jaid Date: Thu, 19 Dec 2019 23:00:39 +0100 Subject: [PATCH] doc: Improved JSDoc types Signed-off-by: Jaid --- src/index.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/index.js b/src/index.js index 201d40e..06b0cc5 100644 --- a/src/index.js +++ b/src/index.js @@ -6,7 +6,7 @@ import fss from "@absolunet/fss" /** * @function * @param {string} file Path to a file - * @returns {Promise} File contents in UTF-8 or null if file could not be read + * @returns {Promise} File contents in UTF-8 or null if file could not be read * @example * import readFileString from "read-file-string" * const result = await readFileString("readme.md") @@ -28,7 +28,7 @@ export default async file => { /** * @function * @param {string} file Path to a file - * @returns {string} File contents in UTF-8 or null if file could not be read + * @returns {string|null} File contents in UTF-8 or null if file could not be read * @example * import {readFileStringSync} from "read-file-string" * const result = readFileStringSync("readme.md")