From 21c3ee73f6b691c194465583d8d3618e93500b23 Mon Sep 17 00:00:00 2001 From: JoshuaSBrown Date: Wed, 15 Jan 2025 14:22:18 -0500 Subject: [PATCH] Address eslint --- core/database/foxx/api/record.js | 2 +- core/database/foxx/api/repo.js | 21 +++++++++++++-------- 2 files changed, 14 insertions(+), 9 deletions(-) diff --git a/core/database/foxx/api/record.js b/core/database/foxx/api/record.js index 5612bc875..c50c57747 100644 --- a/core/database/foxx/api/record.js +++ b/core/database/foxx/api/record.js @@ -65,7 +65,7 @@ class Record { /** * Generates the full path to the record as it should appear in the repository. * - * @returns {object} - The location object which specifies the owner of the record. + * @returns {object} loc - The location object which specifies the owner of the record. * @param {string} basePath - The base path where the record is stored. */ _pathToRecord(loc, basePath) { diff --git a/core/database/foxx/api/repo.js b/core/database/foxx/api/repo.js index cc4e5a46c..29a5aac4d 100644 --- a/core/database/foxx/api/repo.js +++ b/core/database/foxx/api/repo.js @@ -49,7 +49,8 @@ class Repo { #repo_key = null; /** - * @brief Constructs a Repo object and checks if the key exists in the database. + * Constructs a Repo object and checks if the key exists in the database. + * * @param {string} a_key or id - The unique identifier for the repo, of repo key. * e.g. can be either * repo/repo_name @@ -92,8 +93,9 @@ class Repo { } /** - * @brief Checks if the repo exists in the database. - * @return {boolean} True if the repo exists, otherwise false. + * Checks if the repo exists in the database. + * + * @returns {boolean} True if the repo exists, otherwise false. */ exists() { return this.#exists; @@ -107,24 +109,27 @@ class Repo { return this.#repo_id; } /** - * @brief Will return error code of last run method. + * Will return error code of last run method. * - * If no error code, will return null + * returns {number} - If no error code, will return null **/ error() { return this.#error; } /** - * @brief Retrieves the error code of the last run method. - * @return {string|null} Error code or null if no error. + * Retrieves the error code of the last run method. + * + * @returns {string|null} Error code or null if no error. */ errorMessage() { return this.#err_msg; } /** - * @brief Detect what kind of POSIX path has been provided + * Detect what kind of POSIX path has been provided + * + * returns {string} - posix path type **/ pathType(a_path) { if (!this.#exists) {