wdio-performancetotal-service - npm Package Compare versions

Comparing version 4.0.2 to 4.0.3

package.json

 {
   "name": "wdio-performancetotal-service",
-  "version": "4.0.2",
+  "version": "4.0.3",
   "description": "WebdriverIO service for analyzing test flow performance",
@@ -5,0 +5,0 @@ "main": "build/app.js",

README.md

@@ -54,5 +54,5 @@ # performance-total
 
-## Options
+### Options
 
-### disableAppendToExistingFile
+#### __disableAppendToExistingFile__
 
@@ -66,5 +66,5 @@ When set to `true`, new test runs will start fresh and overwrite any existing performance data.
 
-### performanceResultsFileName
+#### __performanceResultsFileName__
 
-You can set the default results file name (`performance-results`).
+You can override the default results file name (`performance-results`).
 A newly created results file normally overwrites the old file. If you want to keep old files, it is recommended to add a timestamp to the file name. For example:
@@ -78,11 +78,11 @@
 
-### dropResultsFromFailedTest
+#### __dropResultsFromFailedTest__
 
 Default is `false`. When the value is set to `true`, performance analysis from failed tests would be excluded.
 
-### recentDays
+#### __recentDays__
 
 Default is `0` (no limit). To set the number of days to consider for performance analysis set the number of days. Partial days are also supported (e.g. `recentDays: 0.5`)
 
-### performanceResultsDirectory
+#### __performanceResultsDirectory__
 
@@ -92,9 +92,9 @@ You can override the default path for the results directory in the project's root dir.
 
-```
+```typescript
 ...
-performanceResultsFileName: "results-dir/performance-total-results"
+performanceResultsDirectory: "results-dir/performance-total-results"
 ...
 ```
 
-### analyzeByBrowser
+#### __analyzeByBrowser__
 
@@ -104,3 +104,3 @@ Default is `false`. If `true`, the performance data would be analyzed also by the browser type.
 
-## Usage in test
+### Usage in test
 
@@ -151,2 +151,6 @@ Just import __performancetotal__ where you need it, whether it be in your test file or any other class. This object provides methods for measuring performance data in your tests, including sampleStart and sampleEnd for starting and ending performance measurements.
 
+### Analyzing performance data in bulk
+
+To analyze existing performance data in bulk without generating new tests, it is recommended to use the [__performancetotal-cli__ tool](https://www.npmjs.com/package/performancetotal-cli).
+
 ## Typescript support
@@ -153,0 +157,0 @@

No alert changes

Improved metrics

Total package byte prevSize

35882

increased by0.79%

Number of lines in readme file

156

increased by2.63%

No dependency changes