Fix e2e-test-utils-playwright
's jsdoc and types
#48266
Merged
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.
What and why?
This PR does two things:
e2e-test-utils-playwright
when using from a fixture. Now it correctly shows the jsdoc when hovering over a method.How?
Use the fancy
@borrows
jsdoc magic to borrow jsdoc from a pure function to a class field. Due to some circular dependencies issue, we also have to manually type the class field with: typeof methodName
to show the jsdoc.Testing Instructions
Hover over some util in the supported editors and see the jsdoc.
Screenshots or screencast
jsdoc in VSCode: