playwright/utils/doclint/check_public_api/test/check-nullish/doc.md

# class: Foo

## method: Foo.bar

### option: Foo.bar.x
- `x` <[number]>

### option: Foo.bar.y
- `y` <[number]>

### option: Foo.bar.nullable
- `nullable` <?[string]>

### option: Foo.bar.maybe
- `maybe` <[number]>

### option: Foo.bar.object
- `object` <[Object]>
  - `one` <[number]>
  - `two` <[number]> defaults to `2`.

## method: Foo.baz
- returns: <?[Object]>
  - `abc` <[number]>
  - `def` <[number]> if applicable.
  - `ghi` <[string]>

## method: 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`.

## method: Foo.response
- returns: <?[Response]> A matching [Response] object, or `null` if the response has not been received yet.
chore: generate types, api.json off md rather than html (#4825) 2020-12-26 14:31:41 -08:00			`# class: Foo`

			`## method: Foo.bar`

			`### option: Foo.bar.x`
			- `x` <[number]>

			`### option: Foo.bar.y`
			- `y` <[number]>

			`### option: Foo.bar.nullable`
			- `nullable` <?[string]>

			`### option: Foo.bar.maybe`
			- `maybe` <[number]>

			`### option: Foo.bar.object`
			- `object` <[Object]>
			- `one` <[number]>
			- `two` <[number]> defaults to `2`.

			`## method: Foo.baz`
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			`- returns: <?[Object]>`
			- `abc` <[number]>
			- `def` <[number]> if applicable.
			- `ghi` <[string]>

chore: generate types, api.json off md rather than html (#4825) 2020-12-26 14:31:41 -08:00			`## method: Foo.goBack`
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			`- 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`.

chore: generate types, api.json off md rather than html (#4825) 2020-12-26 14:31:41 -08:00			`## method: Foo.response`
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			- returns: <?[Response]> A matching [Response] object, or `null` if the response has not been received yet.