From 367532cf8dba34a918167653aed35c54a3caf04e Mon Sep 17 00:00:00 2001 From: d98762625 Date: Fri, 5 Apr 2019 17:35:20 +0100 Subject: [PATCH] linting and comment for readFileSync --- src/core/Utils.mjs | 8 +++++++- src/core/dishTranslationTypes/DishListFile.mjs | 1 - 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/src/core/Utils.mjs b/src/core/Utils.mjs index 0472f14d..34f80034 100755 --- a/src/core/Utils.mjs +++ b/src/core/Utils.mjs @@ -1027,7 +1027,13 @@ class Utils { } /** - * + * Synchronously read the raw data from a File object. + * + * Only works in the Node environment + * + * @param {File} file - a File shim object (see src/node/File.mjs) + * @returns {ArrayBuffer} the data from the file in an ArrayBuffer + * @throws {TypeError} thrown if the method is called from a browser environment */ static readFileSync(file) { if (!Utils.isNode()) { diff --git a/src/core/dishTranslationTypes/DishListFile.mjs b/src/core/dishTranslationTypes/DishListFile.mjs index 1e043d66..77848c4a 100644 --- a/src/core/dishTranslationTypes/DishListFile.mjs +++ b/src/core/dishTranslationTypes/DishListFile.mjs @@ -5,7 +5,6 @@ */ import DishTranslationType from "./DishTranslationType"; -import Utils from "../Utils"; /** * Translation methods for ListFile Dishes