codeceptjs 4.2.3 → 4.2.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -254,7 +254,7 @@ I.amOnPage('/login'); // opens a login page
254
254
 
255
255
  * `url` **[string][5]** url path or global url.
256
256
 
257
- Returns **void** automatically synchronized promise through #recorder
257
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
258
258
 
259
259
  ### appendField
260
260
 
@@ -277,7 +277,7 @@ I.appendField('name', 'John', '.form-container');
277
277
  * `value` **[string][5]** text value to append.
278
278
  * `context` **([string][5]? | [object][6])** (optional, `null` by default) element located by CSS | XPath | strict locator.
279
279
 
280
- Returns **void** automatically synchronized promise through #recorder
280
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
281
281
 
282
282
  ### attachFile
283
283
 
@@ -309,7 +309,7 @@ I.attachFile('#dropzone', 'data/avatar.jpg');
309
309
  * `pathToFile` **[string][5]** local file path relative to codecept.conf.ts or codecept.conf.js config file.
310
310
  * `context` **([string][5]? | [object][6])** (optional, `null` by default) element located by CSS | XPath | strict locator.
311
311
 
312
- Returns **void** automatically synchronized promise through #recorder
312
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
313
313
 
314
314
  ### blur
315
315
 
@@ -334,7 +334,7 @@ I.dontSee('#add-to-cart-btn');
334
334
  * `locator` **([string][5] | [object][6])** field located by label|name|CSS|XPath|strict locator.
335
335
  * `options` **any?** Playwright only: [Additional options][9] for available options object as 2nd argument.
336
336
 
337
- Returns **void** automatically synchronized promise through #recorder
337
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
338
338
 
339
339
  ### cancelPopup
340
340
 
@@ -362,7 +362,7 @@ I.checkOption('agree', '//form');
362
362
  * `field` **([string][5] | [object][6])** checkbox located by label | name | CSS | XPath | strict locator.
363
363
  * `context` **([string][5]? | [object][6])** (optional, `null` by default) element located by CSS | XPath | strict locator.
364
364
 
365
- Returns **void** automatically synchronized promise through #recorder
365
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
366
366
 
367
367
  ### clearClipboard
368
368
 
@@ -373,7 +373,7 @@ I.clearClipboard();
373
373
  I.seeClipboardEquals('');
374
374
  ```
375
375
 
376
- Returns **void** automatically synchronized promise through #recorder
376
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
377
377
 
378
378
  ### clearCookie
379
379
 
@@ -410,7 +410,7 @@ I.clearField('Email', '.form-container');
410
410
  * `context` **([string][5]? | [object][6])** (optional, `null` by default) element located by CSS | XPath | strict locator.
411
411
  * `editable` **([string][5] | [object][6])** field located by label|name|CSS|XPath|strict locator.
412
412
 
413
- Returns **void** automatically synchronized promise through #recorder.
413
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder.
414
414
 
415
415
  ### click
416
416
 
@@ -449,7 +449,7 @@ I.click({role: 'button', name: 'Submit'});
449
449
  * `locator` **([string][5] | [object][6])** (optional, `'//body'` by default) clickable link or button located by text, or any element located by CSS|XPath|strict locator.
450
450
  * `context` **([string][5]? | [object][6] | null)** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
451
451
 
452
- Returns **void** automatically synchronized promise through #recorder
452
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
453
453
 
454
454
  ### clickLink
455
455
 
@@ -464,7 +464,7 @@ I.clickLink('Logout', '#nav');
464
464
  * `locator` **([string][5] | [object][6])** clickable link or button located by text, or any element located by CSS|XPath|strict locator
465
465
  * `context` **([string][5]? | [object][6])** (optional, `null` by default) element to search in CSS|XPath|Strict locator
466
466
 
467
- Returns **void** automatically synchronized promise through #recorder
467
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
468
468
 
469
469
  ### clickXY
470
470
 
@@ -519,7 +519,7 @@ I.dontSee('Login', '.nav'); // no login inside .nav element
519
519
  * `text` **[string][5]** which is not present.
520
520
  * `context` **([string][5] | [object][6])?** (optional) element located by CSS|XPath|strict locator in which to perfrom search.
521
521
 
522
- Returns **void** automatically synchronized promise through #recorder
522
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
523
523
 
524
524
  ### dontSeeCheckboxIsChecked
525
525
 
@@ -535,7 +535,7 @@ I.dontSeeCheckboxIsChecked('agree'); // located by name
535
535
 
536
536
  * `field` **([string][5] | [object][6])** located by label|name|CSS|XPath|strict locator.
537
537
 
538
- Returns **void** automatically synchronized promise through #recorder
538
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
539
539
 
540
540
  ### dontSeeCookie
541
541
 
@@ -549,7 +549,7 @@ I.dontSeeCookie('auth'); // no auth cookie
549
549
 
550
550
  * `name` **[string][5]** cookie name.
551
551
 
552
- Returns **void** automatically synchronized promise through #recorder
552
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
553
553
 
554
554
  ### dontSeeCurrentPathEquals
555
555
 
@@ -565,7 +565,7 @@ I.dontSeeCurrentPathEquals('/'); // fails for '/', '/?user=ok', '/#top'
565
565
 
566
566
  * `path` **[string][5]** value to check.
567
567
 
568
- Returns **void** automatically synchronized promise through #recorder
568
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
569
569
 
570
570
  ### dontSeeCurrentUrlEquals
571
571
 
@@ -581,7 +581,7 @@ I.dontSeeCurrentUrlEquals('http://mysite.com/login'); // absolute urls are also
581
581
 
582
582
  * `url` **[string][5]** value to check.
583
583
 
584
- Returns **void** automatically synchronized promise through #recorder
584
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
585
585
 
586
586
  ### dontSeeElement
587
587
 
@@ -599,7 +599,7 @@ I.dontSeeElement('.modal', '#container');
599
599
  * `locator` **([string][5] | [object][6])** located by CSS|XPath|Strict locator.
600
600
  * `context` **([string][5]? | [object][6])** (optional, `null` by default) element located by CSS | XPath | strict locator.
601
601
 
602
- Returns **void** automatically synchronized promise through #recorder
602
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
603
603
 
604
604
  ### dontSeeElementInDOM
605
605
 
@@ -613,7 +613,7 @@ I.dontSeeElementInDOM('.nav'); // checks that element is not on page visible or
613
613
 
614
614
  * `locator` **([string][5] | [object][6])** located by CSS|XPath|Strict locator.
615
615
 
616
- Returns **void** automatically synchronized promise through #recorder
616
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
617
617
 
618
618
  ### dontSeeInCurrentUrl
619
619
 
@@ -623,7 +623,7 @@ Checks that current url does not contain a provided fragment.
623
623
 
624
624
  * `url` **[string][5]** value to check.
625
625
 
626
- Returns **void** automatically synchronized promise through #recorder
626
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
627
627
 
628
628
  ### dontSeeInField
629
629
 
@@ -645,7 +645,7 @@ I.dontSeeInField('Name', 'old_value', '.form-container');
645
645
  * `value` **([string][5] | [object][6])** value to check.
646
646
  * `context` **([string][5]? | [object][6])** (optional, `null` by default) element located by CSS | XPath | strict locator.
647
647
 
648
- Returns **void** automatically synchronized promise through #recorder
648
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
649
649
 
650
650
  ### dontSeeInSource
651
651
 
@@ -660,7 +660,7 @@ I.dontSeeInSource('<!--'); // no comments in source
660
660
  * `text` &#x20;
661
661
  * `value` **[string][5]** to check.
662
662
 
663
- Returns **void** automatically synchronized promise through #recorder
663
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
664
664
 
665
665
  ### dontSeeInTitle
666
666
 
@@ -674,7 +674,7 @@ I.dontSeeInTitle('Error');
674
674
 
675
675
  * `text` **[string][5]** value to check.
676
676
 
677
- Returns **void** automatically synchronized promise through #recorder
677
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
678
678
 
679
679
  ### dontSeeTraffic
680
680
 
@@ -713,7 +713,7 @@ I.doubleClick('.btn.edit');
713
713
  * `locator` **([string][5] | [object][6])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
714
714
  * `context` **([string][5]? | [object][6])** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
715
715
 
716
- Returns **void** automatically synchronized promise through #recorder
716
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
717
717
 
718
718
  ### downloadFile
719
719
 
@@ -739,7 +739,7 @@ I.dragAndDrop('#dragHandle', '#container');
739
739
  * `srcElement` **([string][5] | [object][6])** located by CSS|XPath|strict locator.
740
740
  * `destElement` **([string][5] | [object][6])** located by CSS|XPath|strict locator.
741
741
 
742
- Returns **void** automatically synchronized promise through #recorder
742
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
743
743
 
744
744
  ### dragSlider
745
745
 
@@ -756,7 +756,7 @@ I.dragSlider('#slider', -70);
756
756
  * `locator` **([string][5] | [object][6])** located by label|name|CSS|XPath|strict locator.
757
757
  * `offsetX` **[number][11]** position to drag.
758
758
 
759
- Returns **void** automatically synchronized promise through #recorder
759
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
760
760
 
761
761
  ### executeAsyncScript
762
762
 
@@ -854,7 +854,7 @@ I.fillField('Name', 'John', '#section2');
854
854
  * `value` **([string][5] | [object][6])** text value to fill.
855
855
  * `context` **([string][5]? | [object][6])** (optional, `null` by default) element located by CSS | XPath | strict locator.
856
856
 
857
- Returns **void** automatically synchronized promise through #recorder
857
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
858
858
 
859
859
  ### flushNetworkTraffics
860
860
 
@@ -885,7 +885,7 @@ I.see('#add-to-cart-bnt');
885
885
  * `locator` **([string][5] | [object][6])** field located by label|name|CSS|XPath|strict locator.
886
886
  * `options` **any?** Playwright only: [Additional options][16] for available options object as 2nd argument.
887
887
 
888
- Returns **void** automatically synchronized promise through #recorder
888
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
889
889
 
890
890
  ### forceClick
891
891
 
@@ -919,7 +919,7 @@ I.forceClick({css: 'nav a.login'});
919
919
  * `locator` **([string][5] | [object][6])** clickable link or button located by text, or any element located by CSS|XPath|strict locator.
920
920
  * `context` **([string][5]? | [object][6])** (optional, `null` by default) element to search in CSS|XPath|Strict locator.
921
921
 
922
- Returns **void** automatically synchronized promise through #recorder
922
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
923
923
 
924
924
  ### grabAriaSnapshot
925
925
 
@@ -1066,7 +1066,7 @@ let data = await I.grabDataFromPerformanceTiming();
1066
1066
  }
1067
1067
  ```
1068
1068
 
1069
- Returns **void** automatically synchronized promise through #recorder
1069
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1070
1070
 
1071
1071
  ### grabElementBoundingRect
1072
1072
 
@@ -1302,7 +1302,7 @@ const webElement = await I.grabWebElement('#button');
1302
1302
 
1303
1303
  * `locator` **([string][5] | [object][6])** element located by CSS|XPath|strict locator.
1304
1304
 
1305
- Returns **[Promise][12]<any>** WebElement of being used Web helper
1305
+ Returns **[Promise][12]<CodeceptJS.WebElement>** WebElement of being used Web helper
1306
1306
 
1307
1307
  ### grabWebElements
1308
1308
 
@@ -1317,7 +1317,7 @@ const webElements = await I.grabWebElements('#button');
1317
1317
 
1318
1318
  * `locator` **([string][5] | [object][6])** element located by CSS|XPath|strict locator.
1319
1319
 
1320
- Returns **[Promise][12]<any>** WebElement of being used Web helper
1320
+ Returns **[Promise][12]<[Array][18]<CodeceptJS.WebElement>>** WebElements of being used Web helper
1321
1321
 
1322
1322
  ### grabWebSocketMessages
1323
1323
 
@@ -1380,7 +1380,7 @@ I.moveCursorTo('#submit', '.container');
1380
1380
  * `offsetX` **([number][11] | [string][5] | [object][6])** (optional, `0` by default) X-axis offset or context locator.
1381
1381
  * `offsetY` **[number][11]** (optional, `0` by default) Y-axis offset.
1382
1382
 
1383
- Returns **void** automatically synchronized promise through #recorder
1383
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
1384
1384
 
1385
1385
  ### openNewTab
1386
1386
 
@@ -1457,7 +1457,7 @@ Some of the supported key names are:
1457
1457
 
1458
1458
  * `key` **([string][5] | [Array][18]<[string][5]>)** key or array of keys to press.
1459
1459
 
1460
- Returns **void** automatically synchronized promise through #recorder
1460
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1461
1461
 
1462
1462
  ### pressKeyDown
1463
1463
 
@@ -1475,7 +1475,7 @@ I.pressKeyUp('Control');
1475
1475
 
1476
1476
  * `key` **[string][5]** name of key to press down.
1477
1477
 
1478
- Returns **void** automatically synchronized promise through #recorder
1478
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1479
1479
 
1480
1480
  ### pressKeyUp
1481
1481
 
@@ -1493,7 +1493,7 @@ I.pressKeyUp('Control');
1493
1493
 
1494
1494
  * `key` **[string][5]** name of key to release.
1495
1495
 
1496
- Returns **void** automatically synchronized promise through #recorder
1496
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1497
1497
 
1498
1498
  ### refreshPage
1499
1499
 
@@ -1503,7 +1503,7 @@ Reload the current page.
1503
1503
  I.refreshPage();
1504
1504
  ```
1505
1505
 
1506
- Returns **void** automatically synchronized promise through #recorder
1506
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1507
1507
 
1508
1508
  ### resizeWindow
1509
1509
 
@@ -1519,7 +1519,7 @@ First parameter can be set to `maximize`.
1519
1519
  * `width` **[number][11]** width in pixels or `maximize`.
1520
1520
  * `height` **[number][11]** height in pixels.
1521
1521
 
1522
- Returns **void** automatically synchronized promise through #recorder
1522
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1523
1523
 
1524
1524
  ### rightClick
1525
1525
 
@@ -1539,7 +1539,7 @@ I.rightClick('Click me', '.context');
1539
1539
  * `locator` **([string][5] | [object][6])** clickable element located by CSS|XPath|strict locator.
1540
1540
  * `context` **([string][5]? | [object][6])** (optional, `null` by default) element located by CSS|XPath|strict locator.
1541
1541
 
1542
- Returns **void** automatically synchronized promise through #recorder
1542
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
1543
1543
 
1544
1544
  ### saveElementScreenshot
1545
1545
 
@@ -1555,7 +1555,7 @@ I.saveElementScreenshot(`#submit`,'debug.png');
1555
1555
  * `locator` **([string][5] | [object][6])** element located by CSS|XPath|strict locator.
1556
1556
  * `fileName` **[string][5]** file name to save.
1557
1557
 
1558
- Returns **void** automatically synchronized promise through #recorder
1558
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
1559
1559
 
1560
1560
  ### saveScreenshot
1561
1561
 
@@ -1573,7 +1573,7 @@ I.saveScreenshot('debug.png', true) //resizes to available scrollHeight and scro
1573
1573
  * `fileName` **[string][5]** file name to save.
1574
1574
  * `fullPage` **[boolean][25]** (optional, `false` by default) flag to enable fullscreen screenshot mode.
1575
1575
 
1576
- Returns **void** automatically synchronized promise through #recorder
1576
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1577
1577
 
1578
1578
  ### scrollPageToBottom
1579
1579
 
@@ -1583,7 +1583,7 @@ Scroll page to the bottom.
1583
1583
  I.scrollPageToBottom();
1584
1584
  ```
1585
1585
 
1586
- Returns **void** automatically synchronized promise through #recorder
1586
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1587
1587
 
1588
1588
  ### scrollPageToTop
1589
1589
 
@@ -1593,7 +1593,7 @@ Scroll page to the top.
1593
1593
  I.scrollPageToTop();
1594
1594
  ```
1595
1595
 
1596
- Returns **void** automatically synchronized promise through #recorder
1596
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1597
1597
 
1598
1598
  ### scrollTo
1599
1599
 
@@ -1611,7 +1611,7 @@ I.scrollTo('#submit', 5, 5);
1611
1611
  * `offsetX` **[number][11]** (optional, `0` by default) X-axis offset.
1612
1612
  * `offsetY` **[number][11]** (optional, `0` by default) Y-axis offset.
1613
1613
 
1614
- Returns **void** automatically synchronized promise through #recorder
1614
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
1615
1615
 
1616
1616
  ### see
1617
1617
 
@@ -1629,7 +1629,7 @@ I.see('Register', {css: 'form.register'}); // use strict locator
1629
1629
  * `text` **[string][5]** expected on page.
1630
1630
  * `context` **([string][5]? | [object][6])** (optional, `null` by default) element located by CSS|Xpath|strict locator in which to search for text.
1631
1631
 
1632
- Returns **void** automatically synchronized promise through #recorder
1632
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1633
1633
 
1634
1634
  ### seeAttributesOnElements
1635
1635
 
@@ -1644,7 +1644,7 @@ I.seeAttributesOnElements('//form', { method: "post"});
1644
1644
  * `locator` **([string][5] | [object][6])** located by CSS|XPath|strict locator.
1645
1645
  * `attributes` **[object][6]** attributes and their values to check.
1646
1646
 
1647
- Returns **void** automatically synchronized promise through #recorder
1647
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1648
1648
 
1649
1649
  ### seeCheckboxIsChecked
1650
1650
 
@@ -1660,7 +1660,7 @@ I.seeCheckboxIsChecked({css: '#signup_form input[type=checkbox]'});
1660
1660
 
1661
1661
  * `field` **([string][5] | [object][6])** located by label|name|CSS|XPath|strict locator.
1662
1662
 
1663
- Returns **void** automatically synchronized promise through #recorder
1663
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1664
1664
 
1665
1665
  ### seeClipboardEquals
1666
1666
 
@@ -1678,7 +1678,7 @@ in Chromium-based browsers, where read access is granted automatically.
1678
1678
 
1679
1679
  * `text` **[string][5]** value to check.
1680
1680
 
1681
- Returns **void** automatically synchronized promise through #recorder
1681
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1682
1682
 
1683
1683
  ### seeCookie
1684
1684
 
@@ -1692,7 +1692,7 @@ I.seeCookie('Auth');
1692
1692
 
1693
1693
  * `name` **[string][5]** cookie name.
1694
1694
 
1695
- Returns **void** automatically synchronized promise through #recorder
1695
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1696
1696
 
1697
1697
  ### seeCssPropertiesOnElements
1698
1698
 
@@ -1707,7 +1707,7 @@ I.seeCssPropertiesOnElements('h3', { 'font-weight': "bold"});
1707
1707
  * `locator` **([string][5] | [object][6])** located by CSS|XPath|strict locator.
1708
1708
  * `cssProperties` **[object][6]** object with CSS properties and their values to check.
1709
1709
 
1710
- Returns **void** automatically synchronized promise through #recorder
1710
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1711
1711
 
1712
1712
  ### seeCurrentPathEquals
1713
1713
 
@@ -1723,7 +1723,7 @@ I.seeCurrentPathEquals('/'); // passes for '/', '/?user=ok', '/#top'
1723
1723
 
1724
1724
  * `path` **[string][5]** value to check.
1725
1725
 
1726
- Returns **void** automatically synchronized promise through #recorder
1726
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1727
1727
 
1728
1728
  ### seeCurrentUrlEquals
1729
1729
 
@@ -1740,7 +1740,7 @@ I.seeCurrentUrlEquals('http://my.site.com/register');
1740
1740
 
1741
1741
  * `url` **[string][5]** value to check.
1742
1742
 
1743
- Returns **void** automatically synchronized promise through #recorder
1743
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1744
1744
 
1745
1745
  ### seeElement
1746
1746
 
@@ -1763,7 +1763,7 @@ I.seeElement({role: 'dialog'});
1763
1763
  * `locator` **([string][5] | [object][6])** located by CSS|XPath|strict locator.
1764
1764
  * `context` **([string][5]? | [object][6])** (optional, `null` by default) element located by CSS | XPath | strict locator.
1765
1765
 
1766
- Returns **void** automatically synchronized promise through #recorder
1766
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1767
1767
 
1768
1768
  ### seeElementInDOM
1769
1769
 
@@ -1778,7 +1778,7 @@ I.seeElementInDOM('#modal');
1778
1778
 
1779
1779
  * `locator` **([string][5] | [object][6])** element located by CSS|XPath|strict locator.
1780
1780
 
1781
- Returns **void** automatically synchronized promise through #recorder
1781
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1782
1782
 
1783
1783
  ### seeInClipboard
1784
1784
 
@@ -1796,7 +1796,7 @@ in Chromium-based browsers, where read access is granted automatically.
1796
1796
 
1797
1797
  * `text` **[string][5]** value to check.
1798
1798
 
1799
- Returns **void** automatically synchronized promise through #recorder
1799
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1800
1800
 
1801
1801
  ### seeInCurrentUrl
1802
1802
 
@@ -1810,7 +1810,7 @@ I.seeInCurrentUrl('/register'); // we are on registration page
1810
1810
 
1811
1811
  * `url` **[string][5]** a fragment to check
1812
1812
 
1813
- Returns **void** automatically synchronized promise through #recorder
1813
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1814
1814
 
1815
1815
  ### seeInField
1816
1816
 
@@ -1834,7 +1834,7 @@ I.seeInField('Name', 'John', '.form-container');
1834
1834
  * `value` **([string][5] | [object][6])** value to check.
1835
1835
  * `context` **([string][5]? | [object][6])** (optional, `null` by default) element located by CSS | XPath | strict locator.
1836
1836
 
1837
- Returns **void** automatically synchronized promise through #recorder
1837
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1838
1838
 
1839
1839
  ### seeInPopup
1840
1840
 
@@ -1849,7 +1849,7 @@ I.seeInPopup('Popup text');
1849
1849
 
1850
1850
  * `text` **[string][5]** value to check.
1851
1851
 
1852
- Returns **void** automatically synchronized promise through #recorder
1852
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1853
1853
 
1854
1854
  ### seeInSource
1855
1855
 
@@ -1863,7 +1863,7 @@ I.seeInSource('<h1>Green eggs &amp; ham</h1>');
1863
1863
 
1864
1864
  * `text` **[string][5]** value to check.
1865
1865
 
1866
- Returns **void** automatically synchronized promise through #recorder
1866
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1867
1867
 
1868
1868
  ### seeInTitle
1869
1869
 
@@ -1877,7 +1877,7 @@ I.seeInTitle('Home Page');
1877
1877
 
1878
1878
  * `text` **[string][5]** text value to check.
1879
1879
 
1880
- Returns **void** automatically synchronized promise through #recorder
1880
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1881
1881
 
1882
1882
  ### seeNumberOfElements
1883
1883
 
@@ -1893,7 +1893,7 @@ I.seeNumberOfElements('#submitBtn', 1);
1893
1893
  * `locator` **([string][5] | [object][6])** element located by CSS|XPath|strict locator.
1894
1894
  * `num` **[number][11]** number of elements.
1895
1895
 
1896
- Returns **void** automatically synchronized promise through #recorder
1896
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1897
1897
 
1898
1898
  ### seeNumberOfVisibleElements
1899
1899
 
@@ -1909,7 +1909,7 @@ I.seeNumberOfVisibleElements('.buttons', 3);
1909
1909
  * `locator` **([string][5] | [object][6])** element located by CSS|XPath|strict locator.
1910
1910
  * `num` **[number][11]** number of elements.
1911
1911
 
1912
- Returns **void** automatically synchronized promise through #recorder
1912
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1913
1913
 
1914
1914
  ### seeTextEquals
1915
1915
 
@@ -1924,7 +1924,7 @@ I.seeTextEquals('text', 'h1');
1924
1924
  * `text` **[string][5]** element value to check.
1925
1925
  * `context` **([string][5] | [object][6])?** element located by CSS|XPath|strict locator.
1926
1926
 
1927
- Returns **void** automatically synchronized promise through #recorder
1927
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1928
1928
 
1929
1929
  ### seeTitleEquals
1930
1930
 
@@ -1938,7 +1938,7 @@ I.seeTitleEquals('Test title.');
1938
1938
 
1939
1939
  * `text` **[string][5]** value to check.
1940
1940
 
1941
- Returns **void** automatically synchronized promise through #recorder
1941
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
1942
1942
 
1943
1943
  ### seeTraffic
1944
1944
 
@@ -2014,7 +2014,7 @@ I.selectOption('Which OS do you use?', ['Android', 'iOS']);
2014
2014
  * `option` **([string][5] | [Array][18]<any>)** visible text or value of option.
2015
2015
  * `context` **([string][5]? | [object][6])** (optional, `null` by default) element located by CSS | XPath | strict locator.
2016
2016
 
2017
- Returns **void** automatically synchronized promise through #recorder
2017
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
2018
2018
 
2019
2019
  ### setCookie
2020
2020
 
@@ -2036,7 +2036,7 @@ I.setCookie([
2036
2036
 
2037
2037
  * `cookie` **(Cookie | [Array][18]<Cookie>)** a cookie object or array of cookie objects.
2038
2038
 
2039
- Returns **void** automatically synchronized promise through #recorder
2039
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2040
2040
 
2041
2041
  ### setPuppeteerRequestHeaders
2042
2042
 
@@ -2061,7 +2061,7 @@ This also resets recorded network requests.
2061
2061
  I.startRecordingTraffic();
2062
2062
  ```
2063
2063
 
2064
- Returns **void** automatically synchronized promise through #recorder
2064
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2065
2065
 
2066
2066
  ### startRecordingWebSocketMessages
2067
2067
 
@@ -2072,7 +2072,7 @@ This also resets recorded websocket messages.
2072
2072
  await I.startRecordingWebSocketMessages();
2073
2073
  ```
2074
2074
 
2075
- Returns **void** automatically synchronized promise through #recorder
2075
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2076
2076
 
2077
2077
  ### stopMockingRoute
2078
2078
 
@@ -2102,7 +2102,7 @@ Stops recording WS messages. Recorded WS messages is not flashed.
2102
2102
  await I.stopRecordingWebSocketMessages();
2103
2103
  ```
2104
2104
 
2105
- Returns **void** automatically synchronized promise through #recorder
2105
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2106
2106
 
2107
2107
  ### switchTo
2108
2108
 
@@ -2117,7 +2117,7 @@ I.switchTo(); // switch back to main page
2117
2117
 
2118
2118
  * `locator` **([string][5]? | [object][6])** (optional, `null` by default) element located by CSS|XPath|strict locator.
2119
2119
 
2120
- Returns **void** automatically synchronized promise through #recorder
2120
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2121
2121
 
2122
2122
  ### switchToNextTab
2123
2123
 
@@ -2171,7 +2171,7 @@ I.type(secret('123456'));
2171
2171
  * `delay` **[number][11]?** (optional) delay in ms between key presses
2172
2172
  * `key` **([string][5] | [Array][18]<[string][5]>)** or array of keys to type.
2173
2173
 
2174
- Returns **void** automatically synchronized promise through #recorder
2174
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2175
2175
 
2176
2176
  ### uncheckOption
2177
2177
 
@@ -2191,7 +2191,7 @@ I.uncheckOption('agree', '//form');
2191
2191
  * `field` **([string][5] | [object][6])** checkbox located by label | name | CSS | XPath | strict locator.
2192
2192
  * `context` **([string][5]? | [object][6])** (optional, `null` by default) element located by CSS | XPath | strict locator.
2193
2193
 
2194
- Returns **void** automatically synchronized promise through #recorder
2194
+ Returns **CodeceptJS.ElementStepPromise** automatically synchronized promise through #recorder
2195
2195
 
2196
2196
  ### usePuppeteerTo
2197
2197
 
@@ -2225,7 +2225,7 @@ I.wait(2); // wait 2 secs
2225
2225
 
2226
2226
  * `sec` **[number][11]** number of second to wait.
2227
2227
 
2228
- Returns **void** automatically synchronized promise through #recorder
2228
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2229
2229
 
2230
2230
  ### waitCurrentPathEquals
2231
2231
 
@@ -2252,7 +2252,7 @@ I.waitForClickable('.btn.continue', 5); // wait for 5 secs
2252
2252
  * `waitTimeout` &#x20;
2253
2253
  * `sec` **[number][11]?** (optional, `1` by default) time in seconds to wait
2254
2254
 
2255
- Returns **void** automatically synchronized promise through #recorder
2255
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2256
2256
 
2257
2257
  ### waitForCookie
2258
2258
 
@@ -2267,7 +2267,7 @@ I.waitForCookie("token");
2267
2267
  * `name` **[string][5]** expected cookie name.
2268
2268
  * `sec` **[number][11]** (optional, `3` by default) time in seconds to wait
2269
2269
 
2270
- Returns **void** automatically synchronized promise through #recorder
2270
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2271
2271
 
2272
2272
  ### waitForDetached
2273
2273
 
@@ -2283,7 +2283,7 @@ I.waitForDetached('#popup');
2283
2283
  * `locator` **([string][5] | [object][6])** element located by CSS|XPath|strict locator.
2284
2284
  * `sec` **[number][11]** (optional, `1` by default) time in seconds to wait
2285
2285
 
2286
- Returns **void** automatically synchronized promise through #recorder
2286
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2287
2287
 
2288
2288
  ### waitForElement
2289
2289
 
@@ -2300,7 +2300,7 @@ I.waitForElement('.btn.continue', 5); // wait for 5 secs
2300
2300
  * `locator` **([string][5] | [object][6])** element located by CSS|XPath|strict locator.
2301
2301
  * `sec` **[number][11]?** (optional, `1` by default) time in seconds to wait
2302
2302
 
2303
- Returns **void** automatically synchronized promise through #recorder
2303
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2304
2304
 
2305
2305
  ### waitForEnabled
2306
2306
 
@@ -2312,7 +2312,7 @@ Element can be located by CSS or XPath.
2312
2312
  * `locator` **([string][5] | [object][6])** element located by CSS|XPath|strict locator.
2313
2313
  * `sec` **[number][11]** (optional) time in seconds to wait, 1 by default.
2314
2314
 
2315
- Returns **void** automatically synchronized promise through #recorder
2315
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2316
2316
 
2317
2317
  ### waitForFunction
2318
2318
 
@@ -2335,7 +2335,7 @@ I.waitForFunction((count) => window.requests == count, [3], 5) // pass args and
2335
2335
  * `argsOrSec` **([Array][18]<any> | [number][11])?** (optional, `1` by default) arguments for function or seconds.
2336
2336
  * `sec` **[number][11]?** (optional, `1` by default) time in seconds to wait
2337
2337
 
2338
- Returns **void** automatically synchronized promise through #recorder
2338
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2339
2339
 
2340
2340
  ### waitForInvisible
2341
2341
 
@@ -2351,7 +2351,7 @@ I.waitForInvisible('#popup');
2351
2351
  * `locator` **([string][5] | [object][6])** element located by CSS|XPath|strict locator.
2352
2352
  * `sec` **[number][11]** (optional, `1` by default) time in seconds to wait
2353
2353
 
2354
- Returns **void** automatically synchronized promise through #recorder
2354
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2355
2355
 
2356
2356
  ### waitForNavigation
2357
2357
 
@@ -2376,7 +2376,7 @@ I.waitForNumberOfTabs(2);
2376
2376
  * `expectedTabs` **[number][11]** expecting the number of tabs.
2377
2377
  * `sec` **[number][11]** number of secs to wait.
2378
2378
 
2379
- Returns **void** automatically synchronized promise through #recorder
2379
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2380
2380
 
2381
2381
  ### waitForRequest
2382
2382
 
@@ -2423,7 +2423,7 @@ I.waitForText('Thank you, form has been submitted', 5, '#modal');
2423
2423
  * `sec` **[number][11]** (optional, `1` by default) time in seconds to wait
2424
2424
  * `context` **([string][5] | [object][6])?** (optional) element located by CSS|XPath|strict locator.
2425
2425
 
2426
- Returns **void** automatically synchronized promise through #recorder
2426
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2427
2427
 
2428
2428
  ### waitForValue
2429
2429
 
@@ -2439,7 +2439,7 @@ I.waitForValue('//input', "GoodValue");
2439
2439
  * `value` **[string][5]** expected value.
2440
2440
  * `sec` **[number][11]** (optional, `1` by default) time in seconds to wait
2441
2441
 
2442
- Returns **void** automatically synchronized promise through #recorder
2442
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2443
2443
 
2444
2444
  ### waitForVisible
2445
2445
 
@@ -2455,7 +2455,7 @@ I.waitForVisible('#popup');
2455
2455
  * `locator` **([string][5] | [object][6])** element located by CSS|XPath|strict locator.
2456
2456
  * `sec` **[number][11]** (optional, `1` by default) time in seconds to wait
2457
2457
 
2458
- Returns **void** automatically synchronized promise through #recorder
2458
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2459
2459
 
2460
2460
  ### waitInUrl
2461
2461
 
@@ -2470,7 +2470,7 @@ I.waitInUrl('/info', 2);
2470
2470
  * `urlPart` **[string][5]** value to check.
2471
2471
  * `sec` **[number][11]** (optional, `1` by default) time in seconds to wait
2472
2472
 
2473
- Returns **void** automatically synchronized promise through #recorder
2473
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2474
2474
 
2475
2475
  ### waitNumberOfVisibleElements
2476
2476
 
@@ -2486,7 +2486,7 @@ I.waitNumberOfVisibleElements('a', 3);
2486
2486
  * `num` **[number][11]** number of elements.
2487
2487
  * `sec` **[number][11]** (optional, `1` by default) time in seconds to wait
2488
2488
 
2489
- Returns **void** automatically synchronized promise through #recorder
2489
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2490
2490
 
2491
2491
  ### waitToHide
2492
2492
 
@@ -2502,7 +2502,7 @@ I.waitToHide('#popup');
2502
2502
  * `locator` **([string][5] | [object][6])** element located by CSS|XPath|strict locator.
2503
2503
  * `sec` **[number][11]** (optional, `1` by default) time in seconds to wait
2504
2504
 
2505
- Returns **void** automatically synchronized promise through #recorder
2505
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2506
2506
 
2507
2507
  ### waitUrlEquals
2508
2508
 
@@ -2518,7 +2518,7 @@ I.waitUrlEquals('http://127.0.0.1:8000/info');
2518
2518
  * `urlPart` **[string][5]** value to check.
2519
2519
  * `sec` **[number][11]** (optional, `1` by default) time in seconds to wait
2520
2520
 
2521
- Returns **void** automatically synchronized promise through #recorder
2521
+ Returns **CodeceptJS.StepPromise** automatically synchronized promise through #recorder
2522
2522
 
2523
2523
  ### _addPopupListener
2524
2524