yujunjun/playwright
1
0
Fork 0
mirror of https://github.com/microsoft/playwright.git synced 2025-06-26 21:40:17 +00:00
Code Issues Packages Projects Releases Wiki Activity
playwright/utils/doclint/check_public_api/test/check-nullish/doc.md
Joel Einbinder b0749e3a6d
fix(docs): fixup and lint optionals and return values in api.md (#1376) 
Currently in our API `?` means null, but sometimes it means optional. Linting optional/nulls with this patch is required for #1166 to land nicely.

Previously, return types were not being linted in `api.md`. This is fixed, along with many broken return types.

This patch considers `?` to mean nullable, and has some heuristics to determine optionality. I believe this to be the minimal patch needed to unblock #1166. After it lands, we can consider changing the api docs to hopefully remove some heuristics and strangeness.
2020-03-18 16:23:25 -07:00

1.3 KiB
Raw Blame History

class: Foo

foo.bar(options)

foo.baz()

foo.goBack()

  • returns: <Promise<?Response>> Promise which resolves to the main resource response. In case of multiple redirects, the navigation will resolve with the response of the last redirect. If can not go back, resolves to null.

foo.response()

  • returns: <?Response> A matching Response object, or null if the response has not been received yet.