Property

Property

new Property(definitionopt)

The Property class forms the base of all postman collection SDK elements. This is to be used only for SDK development or to extend the SDK with additional functionalities. All SDK classes (constructors) that are supposed to be identifyable (i.e. ones that can have a name and id) are derived from this class.

For more information on what is the structure of the definition the function parameter, have a look at Property~definition.

This is intended to be a private class except for those who want to extend the SDK itself and add more functionalities.

Parameters:
Name Type Attributes Description
definition Property~definition <optional>

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.

Source:
See:

Extends

Members

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
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
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
Source:

Methods

(static) replaceSubstitutions(str, variables) → {String}

This function accepts a string followed by a number of variable sources as arguments. One or more variable sources can be provided and it will use the one that has the value in left-to-right order.

Parameters:
Name Type Description
str String
variables VariableList | Object | Array.<(VariableList|Object)>
Source:
Returns:
Type
String

(static) replaceSubstitutionsIn(obj, variables, mutateopt) → {Object}

This function accepts an object followed by a number of variable sources as arguments. One or more variable sources can be provided and it will use the one that has the value in left-to-right order.

Parameters:
Name Type Attributes Default Description
obj Object
variables Array.<(VariableList|Object)>
mutate Boolean <optional>
false
Source:
Returns:
Type
Object

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.

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:

Type Definitions

definition

Properties:
Name Type Attributes Description
id String <optional>

A unique string that identifies the property.

name String <optional>

A distinctive and human-readable name of the property.

disabled Boolean <optional>

Denotes whether the property is disabled or not.

info Object <optional>

The meta information regarding the Property is provided as the info object.

Properties
Name Type Attributes Description
id String <optional>

If set, this is used instead of the definition root's id.

name String <optional>

If set, this is used instead of the definition root's name.

Source: