docs: typescript migration guide #31243
Open
+176
−0
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
cypress
|
||||||||||||||||||||||||||||||||||||||||
| Project |
cypress
|
| Branch Review |
docs/ts-upgrade-guide
|
| Run status |
|
| Run duration | 18m 30s |
| Commit |
|
| Committer | Cacie Prins |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
9
|
Pending
|
1232
|
Skipped
|
0
|
Passing
|
32101
|
| View all changes introduced in this branch ↗︎ | |
UI Coverage
46.15%
|
|
|---|---|
|
Untested elements
|
184
|
|
Tested elements
|
162
|
Accessibility
92.55%
|
|
|---|---|
|
Failed rules
|
3 critical
8 serious
2 moderate
2 minor
|
|
Failed elements
|
876
|
jennifer-shehane
approved these changes
Mar 10, 2025
AtofStryker
approved these changes
Mar 10, 2025
| .map(n => String(n)) | ||
| ``` | ||
|
|
||
| **Prefer** inline types. Parameter types and return types often do not need to be referenced outside of the function itself. Bag parameters (object literals with more than two properties) should be declared as a named interface. If possible, do not export this interface. If a dependent needs to reference the bag type because it is composing an object literal in preparation to call the function in question, that dependent should use `Parameters<>` instead. This way the interface name can change without necessitating a change to the dependent. Use this technique, example below, as a last resort. Prefer composing the parameter bag inline, rather than assigning it to an identifier. |
There was a problem hiding this comment.
is it worth linking out to the parameters utility type?
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.
Additional details
Adds a guide for writing TypeScript and migrating JS to TS
Steps to test
How has the user experience changed?
PR Tasks
cypress-documentation?type definitions?