chore: add types for Cypress.session.clearAllSavedSessions #19412
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for taking the time to open a PR!
|
|
|
cli/types/cypress.d.ts
Outdated
| @@ -3117,6 +3122,11 @@ declare namespace Cypress { | |||
| onAnyAbort(route: RouteOptions, proxy: any): void | |||
| } | |||
|
|
|||
| interface Session { | |||
| clearAllSavedSessions: () => Promise<void>; | |||
There was a problem hiding this comment.
Mind adding a comment to describe clearAllSavedSessions? It helps with maintenance. You can pull something from https://docs.cypress.io/api/cypress-api/session.
There was a problem hiding this comment.
It mentions something like; Clear all saved sessions and re-run the current spec file.
There was a problem hiding this comment.
Yeah sorry, I missed that at first. :shame:
There was a problem hiding this comment.
No worries! It's not super obvious
emilyrohrbough
changed the title
jennifer-shehane
requested review from
a team and
jennifer-shehane
and removed request for
a team and
jennifer-shehane
BlueWinds
approved these changes
Dec 20, 2021
emilyrohrbough
approved these changes
Dec 20, 2021
tgriesser
added a commit
that referenced
this pull request
Dec 21, 2021
…ert-with-stack * tgriesser/10.0-release/refactor-lifecycle: (50 commits) Remove unused test file update task spec to use correct projectRoot update Fix test Fix test Fix tests update tests fix test correct config path Fix TS resolve conflicts Fixing component & e2e tests build: fix dev process on windows (#19401) fix: `cy.contains()` ignores `<style>` and `<script>` without removing them. (#19424) Fix some tests chore: Fix the broken codeowners automation (#19431) chore: add types for Cypress.session.clearAllSavedSessions (#19412) fix: No unnecessary snapshotting (#19311) chore: Remove pkg/driver @ts-nocheck part 1 (#19353) fix: add CYPRESS_VERIFY_TIMEOUT param and a test for it (#19282) ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
User facing changelog
n/a
Additional details
I only added the public method that's documented, although there are other methods available.
I'm not positive I did this right. 😬 And I didn't see any type tests to modify. Is the return type of
Promise<void>correct?How has the user experience changed?
Typescript types for
Cypress.sessionshould now be available.PR Tasks
cypress-documentation?type definitions?cypress.schema.json?