Skip to content

Commit 9512bb4

Browse files
committed
DOC: Autogenerate and update documentation
1 parent 6326cdd commit 9512bb4

File tree

3 files changed

+96
-0
lines changed

3 files changed

+96
-0
lines changed

docs/helpers/Playwright.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -739,6 +739,22 @@ I.dontSeeCookie('auth'); // no auth cookie
739739

740740
Returns **void** automatically synchronized promise through #recorder
741741

742+
### dontSeeCurrentPathEquals
743+
744+
Checks that current URL path does NOT match the expected path.
745+
Query strings and URL fragments are ignored.
746+
747+
```js
748+
I.dontSeeCurrentPathEquals('/form'); // fails for '/form', '/form?user=1', '/form#section'
749+
I.dontSeeCurrentPathEquals('/'); // fails for '/', '/?user=ok', '/#top'
750+
```
751+
752+
#### Parameters
753+
754+
* `path` **[string][9]** value to check.
755+
756+
Returns **void** automatically synchronized promise through #recorder
757+
742758
### dontSeeCurrentUrlEquals
743759

744760
Checks that current url is not equal to provided one.
@@ -1994,6 +2010,22 @@ I.seeCssPropertiesOnElements('h3', { 'font-weight': "bold"});
19942010

19952011
Returns **void** automatically synchronized promise through #recorder
19962012

2013+
### seeCurrentPathEquals
2014+
2015+
Checks that current URL path matches the expected path.
2016+
Query strings and URL fragments are ignored.
2017+
2018+
```js
2019+
I.seeCurrentPathEquals('/info'); // passes for '/info', '/info?user=1', '/info#section'
2020+
I.seeCurrentPathEquals('/'); // passes for '/', '/?user=ok', '/#top'
2021+
```
2022+
2023+
#### Parameters
2024+
2025+
* `path` **[string][9]** value to check.
2026+
2027+
Returns **void** automatically synchronized promise through #recorder
2028+
19972029
### seeCurrentUrlEquals
19982030

19992031
Checks that current url is equal to provided one.

docs/helpers/Puppeteer.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -622,6 +622,22 @@ I.dontSeeCookie('auth'); // no auth cookie
622622

623623
Returns **void** automatically synchronized promise through #recorder
624624

625+
### dontSeeCurrentPathEquals
626+
627+
Checks that current URL path does NOT match the expected path.
628+
Query strings and URL fragments are ignored.
629+
630+
```js
631+
I.dontSeeCurrentPathEquals('/form'); // fails for '/form', '/form?user=1', '/form#section'
632+
I.dontSeeCurrentPathEquals('/'); // fails for '/', '/?user=ok', '/#top'
633+
```
634+
635+
#### Parameters
636+
637+
* `path` **[string][6]** value to check.
638+
639+
Returns **void** automatically synchronized promise through #recorder
640+
625641
### dontSeeCurrentUrlEquals
626642

627643
Checks that current url is not equal to provided one.
@@ -1762,6 +1778,22 @@ Returns **void** automatically synchronized promise through #recorder
17621778
This action supports [React locators](https://codecept.io/react#locators)
17631779
17641780
1781+
### seeCurrentPathEquals
1782+
1783+
Checks that current URL path matches the expected path.
1784+
Query strings and URL fragments are ignored.
1785+
1786+
```js
1787+
I.seeCurrentPathEquals('/info'); // passes for '/info', '/info?user=1', '/info#section'
1788+
I.seeCurrentPathEquals('/'); // passes for '/', '/?user=ok', '/#top'
1789+
```
1790+
1791+
#### Parameters
1792+
1793+
* `path` **[string][6]** value to check.
1794+
1795+
Returns **void** automatically synchronized promise through #recorder
1796+
17651797
### seeCurrentUrlEquals
17661798
17671799
Checks that current url is equal to provided one.

docs/helpers/WebDriver.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -794,6 +794,22 @@ I.dontSeeCookie('auth'); // no auth cookie
794794

795795
Returns **void** automatically synchronized promise through #recorder
796796

797+
### dontSeeCurrentPathEquals
798+
799+
Checks that current URL path does NOT match the expected path.
800+
Query strings and URL fragments are ignored.
801+
802+
```js
803+
I.dontSeeCurrentPathEquals('/form'); // fails for '/form', '/form?user=1', '/form#section'
804+
I.dontSeeCurrentPathEquals('/'); // fails for '/', '/?user=ok', '/#top'
805+
```
806+
807+
#### Parameters
808+
809+
* `path` **[string][18]** value to check.
810+
811+
Returns **void** automatically synchronized promise through #recorder
812+
797813
### dontSeeCurrentUrlEquals
798814

799815
Checks that current url is not equal to provided one.
@@ -1870,6 +1886,22 @@ I.seeCssPropertiesOnElements('h3', { 'font-weight': "bold"});
18701886
18711887
Returns **void** automatically synchronized promise through #recorder
18721888
1889+
### seeCurrentPathEquals
1890+
1891+
Checks that current URL path matches the expected path.
1892+
Query strings and URL fragments are ignored.
1893+
1894+
```js
1895+
I.seeCurrentPathEquals('/info'); // passes for '/info', '/info?user=1', '/info#section'
1896+
I.seeCurrentPathEquals('/'); // passes for '/', '/?user=ok', '/#top'
1897+
```
1898+
1899+
#### Parameters
1900+
1901+
* `path` **[string][18]** value to check.
1902+
1903+
Returns **void** automatically synchronized promise through #recorder
1904+
18731905
### seeCurrentUrlEquals
18741906
18751907
Checks that current url is equal to provided one.

0 commit comments

Comments
 (0)