Skip to content

Commit eb41f3f

Browse files
docs: Update clearLocalStorage docs to properly document what it yields (#5814)
* docs: Update clearLocalStorage docs to properly document what it yields * Update assertions area to mention assertion chaining behavior
1 parent c66ebfc commit eb41f3f

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

docs/api/commands/clearlocalstorage.mdx

+3-2
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Pass in an options object to change the default behavior of
4848

4949
### Yields [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Subject-Management) {#Yields}
5050

51-
- `cy.clearLocalStorage()` yields `null`.
51+
- `cy.clearLocalStorage()` yields the localStorage for the current domain.
5252

5353
## Examples
5454

@@ -82,7 +82,8 @@ cy.clearLocalStorage(/app-/)
8282

8383
### Assertions [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Assertions) {#Assertions}
8484

85-
- `cy.clearLocalStorage()` cannot have any assertions chained.
85+
- `cy.clearLocalStorage()` will only run assertions you have chained once, and
86+
will not [retry](/guides/core-concepts/retry-ability).
8687

8788
### Timeouts [<Icon name="question-circle"/>](/guides/core-concepts/introduction-to-cypress#Timeouts) {#Timeouts}
8889

0 commit comments

Comments
 (0)