#1244: jsdoc fixes

Accenture · Apr 2, 2024 · 51d9439 · 51d9439
1 parent cd6bfe7
commit 51d9439
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 7 deletions.
diff --git a/lib/index.js b/lib/index.js
@@ -29,6 +29,7 @@ import cache from './util/cache.js';
  * @typedef {import('../types/mcdev.d.js').MetadataTypeMapObj} MetadataTypeMapObj
  * @typedef {import('../types/mcdev.d.js').MultiMetadataTypeList} MultiMetadataTypeList
  * @typedef {import('../types/mcdev.d.js').MultiMetadataTypeMap} MultiMetadataTypeMap
+ * @typedef {import('../types/mcdev.d.js').SkipInteraction} SkipInteraction
  * @typedef {import('../types/mcdev.d.js').SoapRequestParams} SoapRequestParams
  * @typedef {import('../types/mcdev.d.js').SupportedMetadataTypes} SupportedMetadataTypes
  * @typedef {import('../types/mcdev.d.js').TemplateMap} TemplateMap
@@ -49,7 +50,7 @@ class Mcdev {
     /**
      * helper method to use unattended mode when including mcdev as a package
      *
-     * @param {boolean | skipInteraction} [skipInteraction] signals what to insert automatically for things usually asked via wizard
+     * @param {boolean | SkipInteraction} [skipInteraction] signals what to insert automatically for things usually asked via wizard
      * @returns {void}
      */
     static setSkipInteraction(skipInteraction) {
@@ -117,6 +118,7 @@ class Mcdev {
      * @param {string} [argv.range] git commit range
     into deploy directory
      * @param {string} [argv.filter] filter file paths that start with any
+     * @param {number} [argv.commitHistory] filter file paths that start with any
      * @param {DeltaPkgItem[]} [argv.diffArr] list of files to include in delta package (skips git diff when provided)
      * @returns {Promise.<DeltaPkgItem[]>} list of changed items
      */
@@ -513,7 +515,7 @@ class Mcdev {
      * deletes metadata from MC instance by key
      *
      * @param {string} businessUnit references credentials from properties.json
-     * @param {string} type supported metadata type
+     * @param {SupportedMetadataTypes} type supported metadata type
      * @param {string} customerKey Identifier of metadata
      * @returns {Promise.<boolean>} true if successful, false otherwise
      */
@@ -551,7 +553,7 @@ class Mcdev {
      * get name & key for provided id
      *
      * @param {string} businessUnit references credentials from properties.json
-     * @param {string} type supported metadata type
+     * @param {SupportedMetadataTypes} type supported metadata type
      * @param {string} id Identifier of metadata
      * @returns {Promise.<{key:string, name:string, path:string}>} key, name and path of metadata; null if not found
      */
@@ -594,7 +596,7 @@ class Mcdev {
      * ensures triggered sends are restarted to ensure they pick up on changes of the underlying emails
      *
      * @param {string} businessUnit references credentials from properties.json
-     * @param {string} type references credentials from properties.json
+     * @param {SupportedMetadataTypes} type references credentials from properties.json
      * @param {string[]} [keyArr] metadata keys
      * @returns {Promise.<void>} -
      */
@@ -703,7 +705,7 @@ class Mcdev {
      * Retrieve a specific metadata file and templatise.
      *
      * @param {string} businessUnit references credentials from properties.json
-     * @param {string} selectedType supported metadata type
+     * @param {SupportedMetadataTypes} selectedType supported metadata type
      * @param {string[]} name name of the metadata
      * @param {string} market market which should be used to revert template
      * @returns {Promise.<MultiMetadataTypeList>} -
@@ -762,7 +764,7 @@ class Mcdev {
      * @param {string} selectedType supported metadata type
      * @param {string} name name of the metadata
      * @param {string} market market localizations
-     * @returns {Promise.<void>} -
+     * @returns {Promise.<MultiMetadataTypeList>} -
      */
     static async buildDefinition(businessUnit, selectedType, name, market) {
         Util.startLogger();

diff --git a/types/mcdev.d.js b/types/mcdev.d.js
@@ -287,7 +287,7 @@ import SDK from 'sfmc-sdk';
  */
 
 /**
- * @typedef {object} skipInteraction signals what to insert automatically for things usually asked via wizard
+ * @typedef {object} SkipInteraction signals what to insert automatically for things usually asked via wizard
  * @property {string} client_id client id of installed package
  * @property {string} client_secret client secret of installed package
  * @property {string} auth_url tenant specific auth url of installed package