Update Mouse and Keyboard interface to return Promises

[allansson]

Please fill in this template.

• Use a meaningful title for the pull request. Include the name of the package modified.
• Test the change in your own code. (Compile and run.)
• Add or edit tests to reflect the change.
• Follow the advice from the readme.
• Avoid common mistakes.
• Run pnpm test <package to test>.
• Provide a URL to documentation or source code which provides context for the suggested changes:
  • Migrate Mouse APIs to async xk6-browser#1306
  • Migrate Keyboard APIs to async xk6-browser#1304

[allansson]

Self-review

[allansson]

I tried to find usages in @example tags for all the changes, but I couldn't find any. I figure that I can update them if I find them in subsequent PRs.

[inancgumus]

No worries. There are some usage examples here and here that might help 🤞

[allansson]

Sorry, I could have been more clear. I meant that some JSDoc comments include @examples tags and those need to be updated with await, but I couldn't find any using Cmd + F.

[inancgumus]

Oh, I see. I believe you mean none of the examples have a mouse and keyboard example in their JSDoc comments. It's OK. On a tangent, do you think it would be better if we added some example usages to the mouse and keyboard JSDoc comments (not necessary to do it ATM, but nice-to-have)?

[allansson]

This is where I wish we could generate reference docs from the type definitions instead, because having examples in both places would mean us having to keep examples in sync. If the type definitions were the source of truth for the docs, you'd have the same docs in the IDE and on the web.

[inancgumus]

That would be really useful, so we won't have to type k6-docs manually and keep everything in sync.

However, k6-docs examples are more involved, while typescript examples, on the other hand, are small code snippets (does it make sense to add full-blown examples in the typescript comments? I'm not sure).

[ankur22]

This is where I wish we could generate reference docs from the type definitions instead, because having examples in both places would mean us having to keep examples in sync

This would be very cool! Would make things simpler for sure.

I usually like to create the simplest example showcasing a typical use case in the type definitions e.g. keyboard.type("Hello World"). In the docs themselves I'd place a full blown working example that can be copy and pasted and ran without any modifications.

[inancgumus]

LGTM 👍 Thanks!

[inancgumus]

No worries. There are some usage examples here and here that might help 🤞

[ankur22]

LGTM 🚀