docs(assertions): document options in url.ts

remarkablemark · Oct 21, 2023 · 0c2ea6b · 0c2ea6b
1 parent de433be
commit 0c2ea6b
Showing 1 changed file with 36 additions and 0 deletions.
diff --git a/src/assertions/url.ts b/src/assertions/url.ts
@@ -23,6 +23,15 @@ import { getOptions } from '../utils';
  * Then I see URL "http://localhost:8080/index.html"
  * ```
  *
+ * With [options](https://docs.cypress.io/api/commands/url#Arguments):
+ *
+ * ```gherkin
+ * Then I see URL "/"
+ *   | decode | false |
+ *   | log | true |
+ *   | timeout | 4000 |
+ * ```
+ *
  * @see
  *
  * - {@link Then_I_see_URL_contains | Then I see URL contains}
@@ -55,6 +64,15 @@ Then('I see URL {string}', Then_I_see_URL);
  * Then I see URL contains "http://localhost:8080/index.html"
  * ```
  *
+ * With [options](https://docs.cypress.io/api/commands/url#Arguments):
+ *
+ * ```gherkin
+ * Then I see URL contains "/"
+ *   | decode | false |
+ *   | log | true |
+ *   | timeout | 4000 |
+ * ```
+ *
  * @see
  *
  * - {@link Then_I_see_URL | Then I see URL}
@@ -86,6 +104,15 @@ Then('I see URL contains {string}', Then_I_see_URL_contains);
  * Then I do not see URL "http://localhost:8080/index.html"
  * ```
  *
+ * With [options](https://docs.cypress.io/api/commands/url#Arguments):
+ *
+ * ```gherkin
+ * Then I do not see URL "/"
+ *   | decode | false |
+ *   | log | true |
+ *   | timeout | 4000 |
+ * ```
+ *
  * @see
  *
  * - {@link Then_I_do_not_see_URL_contains | Then I do not see URL contains}
@@ -118,6 +145,15 @@ Then('I do not see URL {string}', Then_I_do_not_see_URL);
  * Then I do not see URL contains "http://localhost:8080/index.html"
  * ```
  *
+ * With [options](https://docs.cypress.io/api/commands/url#Arguments):
+ *
+ * ```gherkin
+ * Then I do not see URL contains "/"
+ *   | decode | false |
+ *   | log | true |
+ *   | timeout | 4000 |
+ * ```
+ *
  * @see
  *
  * - {@link Then_I_do_not_see_URL | Then I do not see URL}