new PropertyBase(definition)
Base of all properties in Postman Collection. It defines the root for all standalone properties for postman collection.
Parameters:
Name | Type | Description |
---|---|---|
definition |
PropertyBase.definition |
- Source:
Methods
(static) propertyIsMeta(value, key) → {boolean}
Filter function to check whether a key starts with underscore or not. These usually are the meta properties. It
returns true
if the criteria is matched.
Parameters:
Name | Type | Description |
---|---|---|
value |
* | |
key |
String |
- Source:
Returns:
- Type
- boolean
(static) propertyUnprefixMeta(value, key) → {String}
Map function that removes the underscore prefix from an object key.
Parameters:
Name | Type | Description |
---|---|---|
value |
* | |
key |
String |
- Source:
Returns:
- Type
- String
(static) toJSON(obj) → {*}
Static function which allows calling toJSON() on any object.
Parameters:
Name | Type | Description |
---|---|---|
obj |
Object |
- Source:
Returns:
- Type
- *
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> |
- Source:
Returns:
- Type
- * | undefined
forEachParent(options, iterator)
Invokes the given iterator for every parent in the parent chain of the given element.
Parameters:
Name | Type | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | A set of options for the parent chain traversal. Properties
|
||||||||||
iterator |
function | The function to call for every parent in the ancestry chain. |
- Source:
- To Do:
-
- Cache the results
meta() → {*}
Returns the meta keys associated with the property
- Source:
Returns:
- Type
- *
parent() → {*|undefined}
Returns the parent of item
- 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.
- Source:
Type Definitions
definition
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
description |
String | Description |
<optional> |
- Source: