Merge pull request #1357 from postmanlabs/fix/jsdoc-error

Fix errors in generating docs and types

CHANGELOG.yaml

@@ -1,3 +1,10 @@
+develop:
+  chores:
+    - >-
+      GH-1357 Fixed a bug where invalid JSDoc prevented generating docs and
+      types
+    - GH-1357 Update types for `getPath`
+
 4.3.0:
   date: 2023-11-18
   new features:

lib/collection/property.js

@@ -16,8 +16,8 @@ var _ = require('../util').lodash,
  *
  * @private
  * @param {*} value Any JS variable within which we are trying to discover {{variables}}
- * @param {[Object]} seen Set of objects traversed before to avoid infinite recursion
- * @param {[Object]} result Set of variables to accumulate result in the recursive call
+ * @param {Set.<Object>} seen Set of objects traversed before to avoid infinite recursion
+ * @param {Set.<Object>} result Set of variables to accumulate result in the recursive call
  * @returns {Object} Set of variables
  */
 function _findSubstitutions (value, seen = new Set(), result = new Set()) {

types/index.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for postman-collection 4.0.2
+// Type definitions for postman-collection 4.3.0
 // Project: https://github.com/postmanlabs/postman-collection
 // Definitions by: PostmanLabs
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -1100,6 +1100,10 @@ declare module "postman-collection" {
          * @param [options] - -
          */
         authorizeRequestUsing(type: string | RequestAuth.definition, options?: VariableList): void;
+        /**
+         * Returns the path of the item
+         */
+        getPath(): string[];
         /**
          * Check whether an object is an instance of PostmanItem.
          * @param obj - -