Skip to content

Commit

Permalink
Address eslint
Browse files Browse the repository at this point in the history
  • Loading branch information
JoshuaSBrown committed Jan 15, 2025
1 parent 76da5d7 commit 21c3ee7
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 9 deletions.
2 changes: 1 addition & 1 deletion core/database/foxx/api/record.js
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ class Record {
/**

Check failure on line 65 in core/database/foxx/api/record.js

View workflow job for this annotation

GitHub Actions / lint-javascript

Missing JSDoc @param "loc" declaration
* 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.

Check failure on line 69 in core/database/foxx/api/record.js

View workflow job for this annotation

GitHub Actions / lint-javascript

Expected @param names to be "loc, basePath". Got "basePath"
*/
_pathToRecord(loc, basePath) {
Expand Down
21 changes: 13 additions & 8 deletions core/database/foxx/api/repo.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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;
Expand All @@ -107,24 +109,27 @@ class Repo {
return this.#repo_id;
}
/**

Check failure on line 111 in core/database/foxx/api/repo.js

View workflow job for this annotation

GitHub Actions / lint-javascript

Missing JSDoc @returns declaration
* @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;
}

/**

Check failure on line 129 in core/database/foxx/api/repo.js

View workflow job for this annotation

GitHub Actions / lint-javascript

Missing JSDoc @param "a_path" declaration

Check failure on line 129 in core/database/foxx/api/repo.js

View workflow job for this annotation

GitHub Actions / lint-javascript

Missing JSDoc @returns declaration
* @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) {
Expand Down

0 comments on commit 21c3ee7

Please sign in to comment.