Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix errors in generating docs and types #1357

Merged
merged 2 commits into from
Feb 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 7 additions & 0 deletions CHANGELOG.yaml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
4 changes: 2 additions & 2 deletions lib/collection/property.js
Original file line number Diff line number Diff line change
Expand Up @@ -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()) {
Expand Down
6 changes: 5 additions & 1 deletion types/index.d.ts
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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 - -
Expand Down