Constructor
new APITestRunner()
A class for creating an APITestRunner.
Methods
run(testPath, inParamsopt, profileNameopt) → {Promise.<Object>}
Runs the API test.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
testPath |
string | The folder path of API test. | |
inParams |
Object |
<optional> |
The list of input parameters to run the API test. |
profileName |
string |
<optional> |
The active profile. |
Returns:
a promise that is fulfilled with the results of the API test that ran.
The returned object contains two keys:
status - the result of the API test: true = passed; false = failed
outParams - the list of returned output parameters from the API test with the key and value
The returned object contains two keys:
status - the result of the API test: true = passed; false = failed
outParams - the list of returned output parameters from the API test with the key and value
- Type
- Promise.<Object>