Update methods on Page type 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 Page APIs to async xk6-browser#1307

[ankur22]

Nicely done! LGTM 🚀

[ankur22]

This ordering makes more sense. Is this also idiomatic?

[allansson]

I would say so, yes.

My gut feeling for how it "should" be is:

1. Complex, named types
2. Primitives
3. null and undefined

For example:

function abc(): Alphabet | string | null

The point is to keep the thing that the user is looking for up front, so that it's easier to find functions that return what you want. And you're unlikely to want to use a function because it returns null or undefined.

[allansson]

The counter-argument is that you should draw attention to the exceptional value (null, undefined or custom error types) to highlight the fact that the function has some special cases that you need to handle.

[allansson]

But what I see most often is that null and undefined go at the end. 🙂

[inancgumus]

Nice work 🙇