QueryParam

QueryParam

new QueryParam(options)

Represents a URL query parameter, which can exist in request URL or POST data.

Parameters:
Name Type Description
options FormParam~definition | String

Pass the initial definition of the query parameter. In case of string, the query parameter is parsed using QueryParam.parseSingle.

Source:

Extends

Members

(static) _postman_propertyAllowsMultipleValues :Boolean

Query params can have multiple values, so set this to true.

Type:
  • Boolean
Source:

(static) _postman_propertyIndexKey :String

Declare the list index key, so that property lists of query parameters work correctly

Type:
  • String
Source:

disabled :Boolean

This (optional) flag denotes whether this property is disabled or not. Usually, this is helpful when a property is part of a PropertyList. For example, in a PropertyList of Headers, the ones that are disabled can be filtered out and not processed.

Type:
  • Boolean
Inherited From:
Source:

id :String

The id of the property is a unique string that identifies this property and can be used to refer to this property from relevant other places. It is a good practice to define the id or let the system auto generate a UUID if one is not defined for properties that require an id.

Type:
  • String
Inherited From:
Source:

name :String

A property can have a distinctive and human-readable name. This is to be used to display the name of the property within Postman, Newman or other runtimes that consume collection. In certain cases, the absence of name might cause the runtime to use the id as a fallback.

Type:
  • String
Inherited From:
Source:

Methods

(static) parse(query) → {Array}

Parse a query string into an array of objects, where each object contains a key and a value.

Parameters:
Name Type Description
query String
Source:
Returns:
Type
Array

(static) parseSingle(param, idx, all) → {Object}

Parses a single query parameter.

Parameters:
Name Type Description
param String
idx Number
all Array.<String>

array of all params, in case this is being called while parsing multiple params.

Source:
Returns:
Type
Object

(static) unparse(params, optionsopt) → {string}

Create a query string from array of parameters (or object of key-values). This function ensures that the double braces "{{" and "}}" are not URL-encoded on unparsing, which allows for variable-substitution.

Parameters:
Name Type Attributes Description
params Array | Object
options Object <optional>
Properties
Name Type Attributes Default Description
encode Boolean <optional>
<nullable>
false

Enables URL encoding of the parameters

ignoreDisabled Boolean <optional>
<nullable>
false

Removes disabled query parameters when set to true.

Source:
Returns:
Type
string

(static) unparseSingle(obj, encode) → {String}

Takes a query param and converts to string

Parameters:
Name Type Description
obj Object
encode Boolean
Source:
Returns:
Type
String

describe(content, typeopt)

This function allows to describe the property for the purpose of detailed identification or documentation generation. This function sets or updates the description child-property of this property.

Parameters:
Name Type Attributes Default Description
content String

The content of the description can be provided here as a string. Note that it is expected that if the content is formatted in any other way than simple text, it should be specified in the subsequent type parameter.

type String <optional>
"text/plain"

The type of the content can be one of the values mentioned in Description.format enumeration - namely text/plain, text/markdown or text/html.

Inherited From:
Source:
Example

Add a description to an instance of Collection

 var Collection = require('postman-collection').Collection,
    mycollection;

// create a blank collection
myCollection = new Collection();
myCollection.describe('Hey! This is a cool collection.');

console.log(myCollection.description.toString()); // read the description

findInParents(property, customizeropt) → {*|undefined}

Tries to find the given property locally, and then proceeds to lookup in each parent, going up the chain as necessary. Lookup will continue until customizer returns a truthy value. If used without a customizer, the lookup will stop at the first parent that contains the property.

Parameters:
Name Type Attributes Description
property String
customizer function <optional>
Inherited From:
Source:
Returns:
Type
* | undefined

forEachParent(optionsopt, iterator)

Invokes the given iterator for every parent in the parent chain of the given element.

Parameters:
Name Type Attributes Default Description
options Object | Boolean <optional>
{}

A set of options for the parent chain traversal.

Properties
Name Type Attributes Default Description
withRoot Boolean <optional>
<nullable>
false

Set to true to include the collection object as well.

iterator function

The function to call for every parent in the ancestry chain.

Inherited From:
Source:
To Do:
  • Cache the results

meta() → {*}

Returns the meta keys associated with the property

Inherited From:
Source:
Returns:
Type
*

parent() → {*|undefined}

Returns the parent of item

Inherited From:
Source:
Returns:
Type
* | undefined

toJSON()

Returns the JSON representation of a property, which conforms to the way it is defined in a collection. You can use this method to get the instantaneous representation of any property, including a Collection.

Inherited From:
Source:

toString() → {String}

Converts the QueryParameter to a single param string.

Source:
Returns:
Type
String

update(param)

Updates the key and value of the query parameter

Parameters:
Name Type Description
param String | Object
Properties
Name Type Attributes Description
key String
value String <optional>
Source:

Type Definitions

definition

Properties:
Name Type Description
key String

The name ("key") of the query parameter.

value String

The value of the parameter.

Source: