addProperty method

Class: ConfigurationPlatform: PuppeteerLanguage: JavaScript SDK:

Adds a user-defined key name/value property that will be associated with tests.

A test property is a user-defined name/value pair that you can associate with a test. You can view these properties as well as filter and group by these properties in the Test Manager.. You can set properties using the Eyes.addProperty method, Configuration.addProperty method, Configuration.setProperties method or Configuration.properties property.

Syntax

let configval = config.addProperty(name, value);

let configval = config.addProperty(prop);

Parameters

name
Type:string
The name of the property.
value
Type:string
The value associated with the name.
prop
Type:PropertyDataPlain
PropertyDataPlain

Return value

Type: Configuration
The value returned is the object that called the method. This allows you to use a fluent style to call the setXXXX methods of the Configuration class.

Remarks

  • Set multiple properties by calling Eyes.addProperty or Configuration.addProperty multiple times with the same property name and with different values.
  • You should not assign a given value to a property more than once in a given test run.
  • You can also associate properties with a batch using BatchInfo.addProperty.