postman-collection - npm Package Compare versions

Comparing version 3.6.4 to 3.6.5

lib/collection/certificate-list.js

@@ -45,3 +45,3 @@ var _ = require('../util').lodash,
      * @param {String} url The url to find the certificate for
-     * @return {Certificate~definition=} The matched certificate
+     * @return {Certificate.definition=} The matched certificate
      */
@@ -48,0 +48,0 @@ resolveOne: function (url) {

lib/collection/certificate.js

@@ -16,3 +16,3 @@ var _ = require('../util').lodash,
  * Certificate instance.
- * @typedef Certificate~definition
+ * @typedef Certificate.definition
  * @property {String} [name] A name for the certificate
@@ -44,3 +44,3 @@ * @property {Array} [matches] A list of match patterns
      *
-     * @param {Certificate~definition=} [options] Object with matches, key, cert and passphrase
+     * @param {Certificate.definition=} [options] Object with matches, key, cert and passphrase
      *
@@ -75,3 +75,3 @@ * @example <caption> Create a new Certificate</caption>
      *
-     * @param {Certificate~definition=} [options] Object with matches, key, cert and passphrase
+     * @param {Certificate.definition=} [options] Object with matches, key, cert and passphrase
      */
@@ -78,0 +78,0 @@ update: function (options) {

lib/collection/collection.js

@@ -14,3 +14,3 @@ var _ = require('../util').lodash,
  * collection instance.
- * @typedef Collection~definition
+ * @typedef Collection.definition
  *
@@ -25,15 +25,15 @@ * @property {Object=} [info] The meta information regarding the collection is provided as the `info` object.
  * the version number. While optional, it is recommended that you use this field to its fullest extent.
- * @property {Array<(Item~definition|ItemGroup~definition)>} [item] Items are the basic unit for a Postman collection.
+ * @property {Array<(Item.definition|ItemGroup.definition)>} [item] Items are the basic unit for a Postman collection.
  * You can think of them as corresponding to a single API endpoint. Each Item has one request and may have multiple API
  * responses associated with it.
- * @property {Variable~definition=} [variable] Collection variables allow you to define a set of variables,
+ * @property {Variable.definition=} [variable] Collection variables allow you to define a set of variables,
  * that are a *part of the collection*, as opposed to environments, which are separate entities.
- * @property {RequestAuth~definition=} [auth] Collection auth allows you to define an authentication,
+ * @property {RequestAuth.definition=} [auth] Collection auth allows you to define an authentication,
  * that *applies to all items* in the collection.
- * @property {Array<Event~definition>=} [event] Postman allows you to configure scripts to run when specific events
+ * @property {Array<Event.definition>=} [event] Postman allows you to configure scripts to run when specific events
  * occur.
- * @property {String|Version~definition=} [version] Version of the collection expressed in [semver](http://semver.org/)
+ * @property {String|Version.definition=} [version] Version of the collection expressed in [semver](http://semver.org/)
  * format.
  *
- * @see {ItemGroup~definition} - Since `Collection` inherits {@link ItemGroup}, the properties supported by ItemGroup
+ * @see {ItemGroup.definition} - Since `Collection` inherits {@link ItemGroup}, the properties supported by ItemGroup
  * are applicable as well.
@@ -70,3 +70,3 @@ *
      *
-     * @param {Collection~definition=} [definition] - Pass the initial definition of the collection (name, id, etc) as
+     * @param {Collection.definition=} [definition] - Pass the initial definition of the collection (name, id, etc) as
      * the `definition` parameter. The definition object is structured exactly as the collection format as defined in
@@ -73,0 +73,0 @@ * [https://www.schema.getpostman.com/](https://www.schema.getpostman.com/). This parameter is optional. That

lib/collection/cookie.js

@@ -31,3 +31,3 @@ var _ = require('../util').lodash,
  * Cookie instance.
- * @typedef Cookie~definition
+ * @typedef Cookie.definition
  *
@@ -84,3 +84,3 @@ * @property {String=} [key] The name of the cookie. Some call it the "name".
      *
-     * @param {Cookie~definition} [options] Pass the initial definition of the Cookie.
+     * @param {Cookie.definition} [options] Pass the initial definition of the Cookie.
      * @example <caption>Create a new Cookie</caption>
@@ -176,3 +176,3 @@ * var Cookie = require('postman-collection').Cookie,
              * as clear text.
-             * @type: {Boolean}
+             * @type {Boolean}
              */
@@ -185,3 +185,3 @@ secure: _.has(options, 'secure') ? Boolean(options.secure) : undefined,
              * prevent cross-site scripting (XSS) attacks perpetrated by stealing cookies via JavaScript.
-             * @type: {Boolean}
+             * @type {Boolean}
              */
@@ -191,3 +191,3 @@ httpOnly: _.has(options, 'httpOnly') ? Boolean(options.httpOnly) : undefined,
             /**
-             * @type: {Boolean}
+             * @type {Boolean}
              */
@@ -198,3 +198,3 @@ hostOnly: _.has(options, 'hostOnly') ? Boolean(options.hostOnly) : undefined,
              * Indicates whether this is a Session Cookie.
-             * @type: {Boolean}
+             * @type {Boolean}
              */
@@ -201,0 +201,0 @@ session: _.has(options, 'session') ? Boolean(options.session) : undefined,

lib/collection/description.js

@@ -36,3 +36,3 @@ var _ = require('../util').lodash,
 /**
- * @typedef Description~definition
+ * @typedef Description.definition
  * @property {String} content
@@ -49,4 +49,4 @@ * @property {String} type
  *
- * @param {Description~definition|String} [definition] The content of the description can be passed as a string when it
- * is in `text/plain` format or otherwise be sent as part of an object adhering to the {@link Description~definition}
+ * @param {Description.definition|String} [definition] The content of the description can be passed as a string when it
+ * is in `text/plain` format or otherwise be sent as part of an object adhering to the {@link Description.definition}
  * structure having `content` and `type`.
@@ -86,3 +86,3 @@ *
      *
-     * @param {String|Description~definition} content
+     * @param {String|Description.definition} content
      * @param {String=} [type]
@@ -89,0 +89,0 @@ * @todo parse version of description

lib/collection/event.js

@@ -8,3 +8,3 @@ var _ = require('../util').lodash,
 /**
- * @typedef Event~definition
+ * @typedef Event.definition
  * @property {String} listen The event-name that this script will be called for. Usually either "test" or "prerequest"
@@ -31,3 +31,3 @@ * @property {Script|String} script A {@link Script} instance that will be executed on this event. In case of a
      *
-     * @param {Event~definition} definition Pass the initial definition of the event as the options parameter.
+     * @param {Event.definition} definition Pass the initial definition of the event as the options parameter.
      */
@@ -45,3 +45,3 @@ Event = function PostmanEvent (definition) {
      *
-     * @param {Event~definition} definition
+     * @param {Event.definition} definition
      */
@@ -48,0 +48,0 @@ update: function (definition) {

lib/collection/form-param.js

@@ -7,3 +7,3 @@ var _ = require('../util').lodash,
 /**
- * @typedef FormParam~definition
+ * @typedef FormParam.definition
  * @property {String} key The name ("key") of the form data parameter.
@@ -18,3 +18,3 @@ * @property {String} value The value of the parameter.
      * @constructor
-     * @param {FormParam~definition} options Pass the initial definition of the form data parameter.
+     * @param {FormParam.definition} options Pass the initial definition of the form data parameter.
      */
@@ -21,0 +21,0 @@ FormParam = function PostmanFormParam (options) {

lib/collection/header.js

@@ -13,3 +13,3 @@ var util = require('../util'),
 /**
- * @typedef Header~definition
+ * @typedef Header.definition
  * @property {String} key The Header name (e.g: 'Content-Type')
@@ -35,3 +35,3 @@ * @property {String} value The value of the header.
      *
-     * @param {Header~definition|String} options - Pass the header definition as an object or the value of the header.
+     * @param {Header.definition|String} options - Pass the header definition as an object or the value of the header.
      * If the value is passed as a string, it should either be in `name:value` format or the second "name" parameter
@@ -169,3 +169,3 @@ * should be used to pass the name as string
     /**
-     * Parses a multi line header string into an array of {@link Header~definition}.
+     * Parses a multi line header string into an array of {@link Header.definition}.
      *
@@ -261,3 +261,3 @@ * @param {String} headerString
      *
-     * @param {Header~definition|String} [value] - Pass the header definition as an object or the value of the header.
+     * @param {Header.definition|String} [value] - Pass the header definition as an object or the value of the header.
      * If the value is passed as a string, it should either be in `name:value` format or the second "name" parameter
@@ -264,0 +264,0 @@ * should be used to pass the name as string

lib/collection/item-group.js

@@ -21,6 +21,6 @@ var _ = require('../util').lodash,
  *
- * @typedef ItemGroup~definition
- * @property {Array<ItemGroup~definition|Item~definition>=} [item]
- * @property {RequestAuth~definition=} [auth]
- * @property {Array<Event~definition>=} [event]
+ * @typedef ItemGroup.definition
+ * @property {Array<ItemGroup.definition|Item.definition>=} [item]
+ * @property {RequestAuth.definition=} [auth]
+ * @property {Array<Event.definition>=} [event]
  *
@@ -67,3 +67,3 @@ * @example
      *
-     * @param {ItemGroup~definition=} [definition] While creating a new instance of ItemGroup, one can provide the
+     * @param {ItemGroup.definition=} [definition] While creating a new instance of ItemGroup, one can provide the
      * initial configuration of the item group with the requests it contains, the authentication applied to all
@@ -291,4 +291,4 @@ * requests, events that the requests responds to, etc.
      *
-     * @param {?String|RequestAuth~definition} type
-     * @param {VariableList~definition=} [options]
+     * @param {?String|RequestAuth.definition} type
+     * @param {VariableList=} [options]
      *
@@ -295,0 +295,0 @@ * @note This function was previously (in v2 of SDK) used to clone request and populate headers. Now it is used to

lib/collection/item.js

@@ -53,9 +53,9 @@ var _ = require('../util').lodash,
  * instance. This is also the object structure returned when `.toJSON()` is called on an Item instance.
- * @typedef Item~definition
+ * @typedef Item.definition
  *
- * @property {Request~definition=} [request] A request represents an HTTP request. If a string, the string is assumed to
+ * @property {Request.definition=} [request] A request represents an HTTP request. If a string, the string is assumed to
  * be the request URL and the method is assumed to be 'GET'.
- * @property {Array<Response~definition>=} [responses] Sample responses for this request can be stored along with the
+ * @property {Array<Response.definition>=} [responses] Sample responses for this request can be stored along with the
  * item definition.
- * @property {Array<Event~definition>=} [events] Postman allows you to configure scripts to run when specific events
+ * @property {Array<Event.definition>=} [events] Postman allows you to configure scripts to run when specific events
  * occur. These scripts are stored here, and can be referenced in the collection by their id.
@@ -88,3 +88,3 @@ *
      *
-     * @param {Item~definition=} [definition] While creating a new instance of Item, one can provide the initial
+     * @param {Item.definition=} [definition] While creating a new instance of Item, one can provide the initial
      * configuration of the item with the the request it sends, the expected sample responses, tests, etc
@@ -318,4 +318,4 @@ *
      *
-     * @param {?String|RequestAuth~definition} type
-     * @param {VariableList~definition=} [options]
+     * @param {?String|RequestAuth.definition} type
+     * @param {VariableList=} [options]
      *
@@ -322,0 +322,0 @@ * @note This function was previously (in v2 of SDK) used to clone request and populate headers. Now it is used to

lib/collection/mutation-tracker.js

@@ -31,3 +31,3 @@ var _ = require('../util').lodash,
      * @param {*} target
-     * @param {MutationTracker~mutation} mutation
+     * @param {MutationTracker.mutation} mutation
      */
@@ -69,3 +69,3 @@ applyMutation = function applyMutation (target, mutation) {
  *
- * @typedef {Array} MutationTracker~mutation
+ * @typedef {Array} MutationTracker.mutation
  */
@@ -76,3 +76,3 @@
  *
- * @typedef MutationTracker~definition
+ * @typedef MutationTracker.definition
  *
@@ -92,3 +92,3 @@ * @property {Array} stream contains the stream mutations tracked
      *
-     * @param {MutationTracker~definition} definition serialized mutation tracker
+     * @param {MutationTracker.definition} definition serialized mutation tracker
      */
@@ -115,3 +115,3 @@ MutationTracker = function MutationTracker (definition) {
      * @private
-     * @param {MutationTracker~mutation} mutation
+     * @param {MutationTracker.mutation} mutation
      */
@@ -138,3 +138,3 @@ addMutation: function (mutation) {
      * @private
-     * @param {MutationTracker~mutation} mutation
+     * @param {MutationTracker.mutation} mutation
      */
@@ -141,0 +141,0 @@ addAndCompact: function (mutation) {

lib/collection/property-base.js

@@ -8,3 +8,3 @@ var _ = require('../util').lodash,
 /**
- * @typedef PropertyBase~definition
+ * @typedef PropertyBase.definition
  * @property {String|Description} [description]
@@ -17,4 +17,3 @@ */
  * @constructor
- * @private
- * @param {PropertyBase~definition} definition
+ * @param {PropertyBase.definition} definition
  */
@@ -42,3 +41,3 @@ PropertyBase = function PropertyBase (definition) {
      *
-     * @param {?Object|Boolean} [options={}] - A set of options for the parent chain traversal.
+     * @param {Object} options - A set of options for the parent chain traversal.
      * @param {?Boolean} [options.withRoot=false] - Set to true to include the collection object as well.
@@ -182,3 +181,3 @@ * @param {Function} iterator - The function to call for every parent in the ancestry chain.
 
-_.assign(PropertyBase, /** @lends Base */ {
+_.assign(PropertyBase, /** @lends PropertyBase */ {
 
@@ -185,0 +184,0 @@ /**

lib/collection/property-list.js

@@ -11,2 +11,6 @@ var _ = require('../util').lodash,
 
+/**
+ * An item constructed of PropertyList.Type.
+ * @typedef {Object} PropertyList.Type
+ */
 _.inherit((
@@ -16,3 +20,3 @@
      * @constructor
-     * @param {String} type
+     * @param {Function} type
      * @param {Object} parent
@@ -198,3 +202,3 @@ * @param {Array} populate
      *
-     * @param {PropertyList~Type} item
+     * @param {PropertyList.Type} item
      *
@@ -226,3 +230,3 @@ * @returns {?Boolean}
      *
-     * @param {Function|String|Type} predicate
+     * @param {Function|String|PropertyList.Type} predicate
      * @param {Object} context Optional context to bind the predicate to.
@@ -229,0 +233,0 @@ */

lib/collection/property.js

@@ -13,3 +13,3 @@ var _ = require('../util').lodash,
 /**
- * @typedef Property~definition
+ * @typedef Property.definition
  * @property {String=} [id] A unique string that identifies the property.
@@ -30,3 +30,3 @@ * @property {String=} [name] A distinctive and human-readable name of the property.
      * For more information on what is the structure of the `definition` the function parameter, have a look at
-     * {@link Property~definition}.
+     * {@link Property.definition}.
      *
@@ -39,7 +39,7 @@ * > This is intended to be a private class except for those who want to extend the SDK itself and add more
      *
-     * @param {Property~definition=} [definition] Every constructor inherited from `Property` is required to call the
+     * @param {Property.definition=} [definition] Every constructor inherited from `Property` is required to call the
      * super constructor function. This implies that construction parameters of every inherited member is propagated
      * to be sent up to this point.
      *
-     * @see Property~definition
+     * @see Property.definition
      */
@@ -46,0 +46,0 @@ Property = function PostmanProperty (definition) {

lib/collection/proxy-config-list.js

@@ -34,3 +34,3 @@ var _ = require('../util').lodash,
      *
-     * @returns {ProxyConfig~definition} The matched proxyConfig object
+     * @returns {ProxyConfig.definition} The matched proxyConfig object
      * @param {URL=} [url] The url for which the proxy config needs to be fetched
@@ -37,0 +37,0 @@ */

lib/collection/proxy-config.js

@@ -24,3 +24,3 @@ var _ = require('../util').lodash,
 * Proxy instance.
-* @typedef ProxyConfig~definition
+* @typedef ProxyConfig.definition
 *
@@ -57,3 +57,3 @@ * @property {String=} [match = 'http+https://*\/*'] The match for which the proxy needs to be configured.
      * @extends {Property}
-     * @param {ProxyConfig~definition=} [options] - Specifies object with props matches, server and tunnel.
+     * @param {ProxyConfig.definition=} [options] - Specifies object with props matches, server and tunnel.
      *
@@ -143,3 +143,3 @@ * @example <caption>Create a new ProxyConfig</caption>
      *
-     * @param {ProxyConfig~definition} options The proxy object structure.
+     * @param {ProxyConfig.definition} options The proxy object structure.
      */
@@ -146,0 +146,0 @@ update: function (options) {

lib/collection/query-param.js

@@ -105,3 +105,3 @@ var _ = require('../util').lodash,
 /**
- * @typedef QueryParam~definition
+ * @typedef QueryParam.definition
  * @property {String} key The name ("key") of the query parameter.
@@ -117,3 +117,3 @@ * @property {String} value The value of the parameter.
      * @extends {Property}
-     * @param {FormParam~definition|String} options Pass the initial definition of the query parameter. In case of
+     * @param {FormParam.definition|String} options Pass the initial definition of the query parameter. In case of
      * string, the query parameter is parsed using {@link QueryParam.parseSingle}.
@@ -120,0 +120,0 @@ */

lib/collection/request-auth.js

@@ -10,3 +10,3 @@ var _ = require('../util').lodash,
  *
- * @typedef RequestAuth~definition
+ * @typedef RequestAuth.definition
  * @property {String=} type The Auth type to use. Check the names in {@link AuthTypes}
@@ -31,3 +31,3 @@ *
      *
-     * @param {RequestAuth~definition} options Pass the initial definition of the Auth.
+     * @param {RequestAuth.definition} options Pass the initial definition of the Auth.
      * @param {Property|PropertyList=} [parent] optionally pass the parent of this auth. aides variable resolution.
@@ -104,3 +104,3 @@ *
      * @param {String} type
-     * @param {VariableList|VariableList~definition=} options - note that options set here would replace all existing
+     * @param {VariableList|Array|Object} options - note that options set here would replace all existing
      * options for the particular auth
@@ -107,0 +107,0 @@ */

lib/collection/request-body.js

@@ -11,2 +11,11 @@ var _ = require('../util').lodash,
 
+/**
+ * @typedef RequestBody.definition
+ * @property {String} mode
+ * @property {String} raw
+ * @property {String} file
+ * @property {Object} graphql
+ * @property {Object[]} formdata
+ * @property {Object[]|String} urlencoded
+ */
 _.inherit((
@@ -13,0 +22,0 @@

lib/collection/request.js

@@ -79,10 +79,10 @@ var util = require('../util'),
 /**
- * @typedef Request~definition
- * @property {String|Url} url The URL of the request. This can be a {@link Url~definition} or a string.
+ * @typedef Request.definition
+ * @property {String|Url} url The URL of the request. This can be a {@link Url.definition} or a string.
  * @property {String} method The request method, e.g: "GET" or "POST".
- * @property {Array<Header~definition>} header The headers that should be sent as a part of this request.
- * @property {RequestBody~definition} body The request body definition.
- * @property {RequestAuth~definition} auth The authentication/signing information for this request.
- * @property {ProxyConfig~definition} proxy The proxy information for this request.
- * @property {Certificate~definition} certificate The certificate information for this request.
+ * @property {Array<Header.definition>} header The headers that should be sent as a part of this request.
+ * @property {RequestBody.definition} body The request body definition.
+ * @property {RequestAuth.definition} auth The authentication/signing information for this request.
+ * @property {ProxyConfig.definition} proxy The proxy information for this request.
+ * @property {Certificate.definition} certificate The certificate information for this request.
  */
@@ -96,3 +96,3 @@ _.inherit((
      * @extends {Property}
-     * @param {Request~definition} options
+     * @param {Request.definition} options
      */
@@ -138,3 +138,3 @@ Request = function PostmanRequest (options) {
      *
-     * @param {Request~definition} options
+     * @param {Request.definition} options
      */
@@ -184,4 +184,4 @@ update: function (options) {
      *
-     * @param {?String|RequestAuth~definition} type
-     * @param {VariableList~definition=} [options]
+     * @param {?String|RequestAuth.definition} type
+     * @param {VariableList=} [options]
      *
@@ -237,3 +237,3 @@ * @note This function was previously (in v2 of SDK) used to clone request and populate headers. Now it is used to
         // @note: options.multiValue will not be respected since, Header._postman_propertyAllowsMultipleValues
-        // gets higher precedence in PropertyLists~toObject.
+        // gets higher precedence in PropertyLists.toObject.
         // @todo: sanitizeKeys for headers by default.
@@ -240,0 +240,0 @@ return this.headers.toObject(options.enabled, !options.ignoreCase, options.multiValue, options.sanitizeKeys);

lib/collection/response.js

@@ -194,9 +194,9 @@ var util = require('../util'),
 /**
- * @typedef Response~definition
+ * @typedef Response.definition
  * @property {Number} code - define the response code
  * @property {String=} [reason] - optionally, if the response has a non-standard response code reason, provide it here
- * @property {Array<Header~definition>} [header]
- * @property {Array<Cookie~definition>} [cookie]
+ * @property {Array<Header.definition>} [header]
+ * @property {Array<Cookie.definition>} [cookie]
  * @property {String} [body]
- * @property {Buffer|ByteArray} [stream]
+ * @property {Buffer|ArrayBuffer} [stream]
  * @property {Number} responseTime
@@ -215,3 +215,3 @@ *
      *
-     * @param {Response~definition} options
+     * @param {Response.definition} options
      */
@@ -389,3 +389,3 @@ Response = function PostmanResponse (options) {
      *
-     * @returns {Response~ResponseContentInfo} - contentInfo for the response
+     * @returns {Response.ResponseContentInfo} - contentInfo for the response
      */
@@ -645,3 +645,3 @@ contentInfo: function () {
      *
-     * @typedef Response~timings
+     * @typedef Response.timings
      * @property {Number} start - timestamp of the request sent from the client (in Unix Epoch milliseconds)
@@ -661,3 +661,3 @@ * @property {Object} offset - event timestamps in millisecond resolution relative to start
      *
-     * @param {Response~timings} timings
+     * @param {Response.timings} timings
      * @returns {Object}
@@ -664,0 +664,0 @@ *

lib/collection/variable-scope.js

@@ -26,6 +26,6 @@ var _ = require('../util').lodash,
  *
- * @typedef VariableScope~definition
+ * @typedef VariableScope.definition
  * @property {String} [id] ID of the scope
  * @property {String} [name] A name of the scope
- * @property {Array.<Variable~definition>} [values] A list of variables defined in an array in form of `{name:String,
+ * @property {Array.<Variable.definition>} [values] A list of variables defined in an array in form of `{name:String,
  * value:String}`
@@ -55,3 +55,3 @@ *
      *
-     * @param {VariableScope~definition} definition The constructor accepts an initial set of values for initialising
+     * @param {VariableScope.definition} definition The constructor accepts an initial set of values for initialising
      * the scope
@@ -97,3 +97,3 @@ * @param {Array<VariableList>=} layers Additional parent scopes to search for and resolve variables
         /**
-         * @memberOf VariableScope.prototype
+         * @memberof VariableScope.prototype
          * @type {VariableList}
@@ -348,3 +348,3 @@ */
      *
-     * @param {MutationTracker~definition} [options] Options for Mutation Tracker. See {@link MutationTracker}
+     * @param {MutationTracker.definition} [options] Options for Mutation Tracker. See {@link MutationTracker}
      */
@@ -351,0 +351,0 @@ enableTracking: function (options) {

lib/collection/variable.js

@@ -16,3 +16,3 @@ var _ = require('../util').lodash,
  *
- * @typedef {Object} Variable~definition
+ * @typedef {Object} Variable.definition
  * @property {*=} [value] - The value of the variable that will be stored and will be typecast to the `type`
@@ -41,3 +41,3 @@ * set in the variable or passed along in this parameter.
      * @extends {Property}
-     * @param {Variable~definition=} [definition] - Specify the initial value and type of the variable.
+     * @param {Variable.definition=} [definition] - Specify the initial value and type of the variable.
      */
@@ -196,3 +196,3 @@ Variable = function PostmanVariable (definition) {
      *
-     * @param {Variable~definition} options
+     * @param {Variable.definition} options
      */
@@ -199,0 +199,0 @@ update: function (options) {

lib/collection/version.js

@@ -7,2 +7,5 @@ var _ = require('../util').lodash,
 
+/**
+ * @typedef {Object|String} Version.definition
+ */
 _.inherit((
@@ -15,10 +18,10 @@
      * @extends {PropertyBase}
-     * @param {Object|String} options
+     * @param {Version.definition} definition
      */
-    Version = function PostmanPropertyVersion (options) {
+    Version = function PostmanPropertyVersion (definition) {
         // in case definition object is missing, there is no point moving forward
-        if (!options) { return; }
+        if (!definition) { return; }
 
         // call the setter to process the version string and assign it to this object
-        this.set(options);
+        this.set(definition);
     }), PropertyBase);
@@ -25,0 +28,0 @@

lib/content-info/index.js

@@ -333,3 +333,3 @@ var util = require('../util'),
      * @param {Response} response - response instance
-     * @returns {Response~ResponseContentInfo} - Return contentInfo of the response
+     * @returns {Response.ResponseContentInfo} - Return contentInfo of the response
      */
@@ -344,3 +344,3 @@ contentInfo: function (response) {
             /**
-             * @typedef Response~ResponseContentInfo
+             * @typedef Response.ResponseContentInfo
              *
@@ -347,0 +347,0 @@ * @property {String} mimeType sanitized mime type

lib/url-pattern/url-match-pattern-list.js

@@ -10,12 +10,16 @@ var _ = require('../util').lodash,
 
-/**
- * UrlMatchPattern is a list of UrlMatchPatterns.
- * This allows you to test for any url over a list of match patterns.
- *
- * @param {Object} parent
- * @param {String[]} list
- * @example <caption>An example UrlMatchPatternList</caption>
- * var matchPatternList = new UrlMatchPatternList(['https://*.google.com/*']);
-*/
 _.inherit((
+
+    /**
+     * UrlMatchPattern is a list of UrlMatchPatterns.
+     * This allows you to test for any url over a list of match patterns.
+     *
+     * @constructor
+     * @extends {PropertyList}
+     *
+     * @param {Object} parent
+     * @param {String[]} list
+     * @example <caption>An example UrlMatchPatternList</caption>
+     * var matchPatternList = new UrlMatchPatternList(['https://*.google.com/*']);
+    */
     UrlMatchPatternList = function (parent, list) {
@@ -22,0 +26,0 @@ UrlMatchPatternList.super_.call(this, UrlMatchPattern, parent, list);

lib/url-pattern/url-match-pattern.js

@@ -40,10 +40,18 @@ var _ = require('../util').lodash,
 /**
- * UrlMatchPattern allows to create rules to define Urls to match for.
- * It is based on Google's Match Pattern - https://developer.chrome.com/extensions/match_patterns
- *
- * @param {Object} options
- * @example <caption>An example UrlMatchPattern</caption>
- * var matchPattern = new UrlMatchPattern('https://*.google.com/*');
-*/
+ * @typedef UrlMatchPattern.definition
+ * @property {String} pattern The url match pattern string
+ */
 _.inherit((
+
+    /**
+     * UrlMatchPattern allows to create rules to define Urls to match for.
+     * It is based on Google's Match Pattern - https://developer.chrome.com/extensions/match_patterns
+     *
+     * @constructor
+     * @extends {Property}
+     * @param {UrlMatchPattern.definition} options
+     *
+     * @example <caption>An example UrlMatchPattern</caption>
+     * var matchPattern = new UrlMatchPattern('https://*.google.com/*');
+    */
     UrlMatchPattern = function UrlMatchPattern (options) {
@@ -50,0 +58,0 @@ // called as new UrlMatchPattern('https+http://*.example.com/*')

package.json

@@ -5,3 +5,3 @@ {
   "author": "Postman Labs <[e-mail]>",
-  "version": "3.6.4",
+  "version": "3.6.5",
   "keywords": [
@@ -24,2 +24,3 @@ "postman"
     "build-docs": "node npm/build-docs.js",
+    "build-types": "node npm/build-types.js",
     "build-schema": "node npm/build-schema.js",
@@ -44,6 +45,6 @@ "build-wiki": "node npm/build-wiki.js",
     "lodash": "4.17.19",
-    "marked": "1.1.0",
+    "marked": "1.1.1",
     "mime-format": "2.0.0",
     "mime-types": "2.1.27",
-    "postman-url-encoder": "2.1.2",
+    "postman-url-encoder": "2.1.3",
     "sanitize-html": "1.20.1",
@@ -56,3 +57,3 @@ "semver": "7.3.2",
     "bipbip": "0.4.1",
-    "browserify": "16.5.1",
+    "browserify": "16.5.2",
     "btoa": "1.2.1",
@@ -68,3 +69,3 @@ "chai": "4.2.0",
     "js-yaml": "3.14.0",
-    "jsdoc": "3.6.4",
+    "jsdoc": "3.6.5",
     "jsdoc-to-markdown": "6.0.1",
@@ -81,3 +82,3 @@ "karma": "3.1.4",
     "postman-jsdoc-theme": "0.0.3",
-    "postman-request": "2.88.1-postman.23",
+    "postman-request": "2.88.1-postman.24",
     "puppeteer": "1.20.0",
@@ -88,3 +89,4 @@ "recursive-readdir": "2.2.2",
     "shelljs": "0.8.4",
-    "strip-json-comments": "3.1.1"
+    "strip-json-comments": "3.1.1",
+    "tsd-jsdoc": "2.5.0"
   },
@@ -100,3 +102,4 @@ "homepage": "https://github.com/postmanlabs/postman-collection#readme",
     ]
-  }
+  },
+  "types": "types/index.d.ts"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

650895

increased by19.47%

Number of package files

80

increased by2.56%

Lines of code

14363

increased by21.45%

Worsened metrics

Dev dependency count

33

increased by3.13%

Dependency changes

• + Addedmarked@1.1.1(transitive)

• + Addedpostman-url-encoder@2.1.3(transitive)

• - Removedmarked@1.1.0(transitive)

• - Removedpostman-url-encoder@2.1.2(transitive)

• Updatedmarked@1.1.1

• Updatedpostman-url-encoder@2.1.3