Skip to content

Commit f7ecaf6

Browse files
committed
chore(store): clear jsdoc/no-defaults warnings in softwarecatalogPlugin
ESLint flagged four `@param {Type} [name=null]` JSDoc shapes as violations of `jsdoc/no-defaults`. The annotation is meant to declare optionality (`[name]`) — defaults belong in the description text. Rewriting the four offenders without semantic change.
1 parent 25909fa commit f7ecaf6

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

src/store/plugins/softwarecatalogPlugin.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ function extractId(value) {
2929
* Build an API URL for an object using its @self metadata.
3030
*
3131
* @param {object} objectItem Object with @self metadata
32-
* @param {string} [action=null] Optional action endpoint (publish, lock, etc.)
32+
* @param {string} [action] Optional action endpoint (publish, lock, etc.). Defaults to null.
3333
* @return {string} The constructed URL
3434
*/
3535
function buildObjectUrl(objectItem, action = null) {
@@ -777,8 +777,8 @@ export function softwarecatalogPlugin() {
777777
* Lock an object.
778778
*
779779
* @param {object} objectItem Object to lock
780-
* @param {string} [process=null] Process name
781-
* @param {number} [duration=null] Duration in seconds
780+
* @param {string} [process] Process name. Defaults to null.
781+
* @param {number} [duration] Duration in seconds. Defaults to null.
782782
* @return {Promise<object>} Updated object
783783
*/
784784
async lockObject(objectItem, process = null, duration = null) {
@@ -869,7 +869,7 @@ export function softwarecatalogPlugin() {
869869
*
870870
* @param {Array<object>} objects Objects to process
871871
* @param {Function} operation Per-object operation function
872-
* @param {Function} [onProgress=null] Progress callback
872+
* @param {Function} [onProgress] Progress callback. Defaults to null.
873873
* @return {Promise<{successful: Array, failed: Array}>} Results
874874
*/
875875
async _runMassOperation(objects, operation, onProgress = null) {

0 commit comments

Comments
 (0)