EPMRPP-80662 || Code review fixes - 3

reportportal · Nov 10, 2022 · 97d2e2f · 97d2e2f
1 parent bc23c2a
commit 97d2e2f
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,6 @@
 ### Added
 - Reporting API method `addParameters`
+- Default browser parameters to steps
 
 ## [5.0.3] - 2022-10-05
 ### Added

diff --git a/README.md b/README.md
@@ -189,6 +189,22 @@ describe('test item', () => {
 });
 ```
 
+```javascript
+// Cucumber - adding parameter to the `step`
+Given('I do something awesome', () => {
+  ReportingApi.addParameters([
+    {
+      key: 'stepParamKey',
+      value: 'stepParamValue',
+    },
+    {
+      value: 'stepParamValue_2',
+    },
+  ]);
+  //...
+});
+```
+
 ### setDescription
 `ReportingApi.setDescription(description: string, suite?: string);`  
 **required**: `description`

diff --git a/src/__tests__/reportingApi.spec.ts b/src/__tests__/reportingApi.spec.ts
@@ -224,7 +224,7 @@ describe('ReportingApi', () => {
   describe('ReportingApi.addParameters', () => {
     const spyOnAddParameters = jest.spyOn(ClientPublicReportingAPI, 'addParameters');
 
-    it('should call clientPublicReportingApi.addParameters method with text and undefined as parameter', () => {
+    it('should call clientPublicReportingApi.addParameters method with parameters', () => {
       ReportingApi.addParameters(parameters);
 
       expect(spyOnAddParameters).toBeCalledWith(parameters);