docs: add java traits to some methods (#5222)

This commit is contained in:
Yury Semikhatsky 2021-01-29 19:15:25 -08:00 committed by GitHub
parent a1d875ed97
commit 9c4668685d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 19 additions and 14 deletions

View file

@ -736,7 +736,7 @@ A glob pattern, regex pattern or predicate receiving [URL] used to register a ro
Optional handler function used to register a routing with [`method: BrowserContext.route`]. Optional handler function used to register a routing with [`method: BrowserContext.route`].
## async method: BrowserContext.waitForEvent ## async method: BrowserContext.waitForEvent
* langs: * langs: csharp, js, python
- alias-python: expect_event - alias-python: expect_event
- returns: <[any]> - returns: <[any]>

View file

@ -182,13 +182,13 @@ Maximum time in milliseconds to wait for the browser instance to start. Defaults
disable timeout. disable timeout.
### option: BrowserType.launch.env ### option: BrowserType.launch.env
* langs: csharp,java * langs: csharp, java
- `env` <[Object]<[string], [string]>> - `env` <[Object]<[string], [string]>>
Specify environment variables that will be visible to the browser. Defaults to `process.env`. Specify environment variables that will be visible to the browser. Defaults to `process.env`.
### option: BrowserType.launch.env ### option: BrowserType.launch.env
* langs: js,python * langs: js, python
- `env` <[Object]<[string], [string]|[float]|[boolean]>> - `env` <[Object]<[string], [string]|[float]|[boolean]>>
Specify environment variables that will be visible to the browser. Defaults to `process.env`. Specify environment variables that will be visible to the browser. Defaults to `process.env`.

View file

@ -1,5 +1,5 @@
# class: CDPSession # class: CDPSession
* langs: js,python * langs: js, python
* extends: [EventEmitter] * extends: [EventEmitter]
The `CDPSession` instances are used to talk raw Chrome Devtools Protocol: The `CDPSession` instances are used to talk raw Chrome Devtools Protocol:

View file

@ -39,7 +39,7 @@ not performed and user has no access to the downloaded files.
::: :::
## async method: Download.createReadStream ## async method: Download.createReadStream
* langs: js * langs: java, js
- returns: <[null]|[Readable]> - returns: <[null]|[Readable]>
Returns readable stream for current download or `null` if download failed. Returns readable stream for current download or `null` if download failed.

View file

@ -594,6 +594,8 @@ Attribute name to get the value for.
### option: Frame.getAttribute.timeout = %%-input-timeout-%% ### option: Frame.getAttribute.timeout = %%-input-timeout-%%
## async method: Frame.goto ## async method: Frame.goto
* langs:
- alias-java: navigate
- returns: <[null]|[Response]> - returns: <[null]|[Response]>
Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the

View file

@ -1261,7 +1261,7 @@ frame = page.frame(url=r".*domain.*")
``` ```
### param: Page.frame.frameSelector ### param: Page.frame.frameSelector
* langs: js * langs: java, js
- `frameSelector` <[string]|[Object]> - `frameSelector` <[string]|[Object]>
- `name` <[string]> Frame name specified in the `iframe`'s `name` attribute. Optional. - `name` <[string]> Frame name specified in the `iframe`'s `name` attribute. Optional.
- `url` <[string]|[RegExp]|[function]\([URL]\):[boolean]> A glob pattern, regex pattern or predicate receiving - `url` <[string]|[RegExp]|[function]\([URL]\):[boolean]> A glob pattern, regex pattern or predicate receiving
@ -1313,6 +1313,8 @@ Navigate to the next page in history.
### option: Page.goForward.waitUntil = %%-navigation-wait-until-%% ### option: Page.goForward.waitUntil = %%-navigation-wait-until-%%
## async method: Page.goto ## async method: Page.goto
* langs:
- alias-java: navigate
- returns: <[null]|[Response]> - returns: <[null]|[Response]>
Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the Returns the main resource response. In case of multiple redirects, the navigation will resolve with the response of the
@ -2157,7 +2159,7 @@ Video object associated with this page.
- `height` <[int]> page height in pixels. - `height` <[int]> page height in pixels.
## async method: Page.waitForEvent ## async method: Page.waitForEvent
* langs: * langs: csharp, js, python
- alias-python: expect_event - alias-python: expect_event
- returns: <[any]> - returns: <[any]>

View file

@ -30,6 +30,7 @@ Optional error code. Defaults to `failed`, could be one of the following:
## async method: Route.continue ## async method: Route.continue
* langs: * langs:
- alias-java: continue_
- alias-python: continue_ - alias-python: continue_
Continues route's request with optional overrides. Continues route's request with optional overrides.

View file

@ -57,7 +57,7 @@ Name that is used in selectors as a prefix, e.g. `{name: 'foo'}` enables `foo=my
contain `[a-zA-Z0-9_]` characters. contain `[a-zA-Z0-9_]` characters.
### param: Selectors.register.script ### param: Selectors.register.script
* langs: js * langs: java, js
- `script` <[function]|[string]|[Object]> - `script` <[function]|[string]|[Object]>
- `path` <[path]> Path to the JavaScript file. If `path` is a relative path, then it is resolved relative to the - `path` <[path]> Path to the JavaScript file. If `path` is a relative path, then it is resolved relative to the
current working directory. Optional. current working directory. Optional.

View file

@ -35,7 +35,7 @@ Indicates that the web socket has been closed.
Contains the URL of the WebSocket. Contains the URL of the WebSocket.
## async method: WebSocket.waitForEvent ## async method: WebSocket.waitForEvent
* langs: * langs: csharp, js, python
- alias-python: expect_event - alias-python: expect_event
- returns: <[any]> - returns: <[any]>

View file

@ -147,7 +147,7 @@ Whether to ignore HTTPS errors during navigation. Defaults to `false`.
Toggles bypassing page's Content-Security-Policy. Toggles bypassing page's Content-Security-Policy.
## context-option-viewport ## context-option-viewport
* langs: js * langs: java, js
- `viewport` <[null]|[Object]> - `viewport` <[null]|[Object]>
- `width` <[int]> page width in pixels. - `width` <[int]> page width in pixels.
- `height` <[int]> page height in pixels. - `height` <[int]> page height in pixels.
@ -292,7 +292,7 @@ Logger sink for Playwright logging.
**DEPRECATED** Use [`option: recordVideo`] instead. **DEPRECATED** Use [`option: recordVideo`] instead.
## context-option-recordhar ## context-option-recordhar
* langs: js * langs: java, js
- `recordHar` <[Object]> - `recordHar` <[Object]>
- `omitContent` <[boolean]> Optional setting to control whether to omit request content from the HAR. Defaults to - `omitContent` <[boolean]> Optional setting to control whether to omit request content from the HAR. Defaults to
`false`. `false`.
@ -315,7 +315,7 @@ Optional setting to control whether to omit request content from the HAR. Defaul
Path on the filesystem to write the HAR file to. Path on the filesystem to write the HAR file to.
## context-option-recordvideo ## context-option-recordvideo
* langs: js * langs: java, js
- `recordVideo` <[Object]> - `recordVideo` <[Object]>
- `dir` <[path]> Path to the directory to put videos into. - `dir` <[path]> Path to the directory to put videos into.
- `size` <[Object]> Optional dimensions of the recorded videos. If not specified the size will be equal to `viewport`. - `size` <[Object]> Optional dimensions of the recorded videos. If not specified the size will be equal to `viewport`.
@ -356,7 +356,7 @@ option to work. If all contexts override the proxy, global proxy will be never u
`launch({ proxy: { server: 'per-context' } })`. `launch({ proxy: { server: 'per-context' } })`.
## select-options-values ## select-options-values
* langs: js * langs: java, js
- `values` <[null]|[string]|[ElementHandle]|[Array]<[string]>|[Object]|[Array]<[ElementHandle]>|[Array]<[Object]>> - `values` <[null]|[string]|[ElementHandle]|[Array]<[string]>|[Object]|[Array]<[ElementHandle]>|[Array]<[Object]>>
- `value` <[string]> Matches by `option.value`. Optional. - `value` <[string]> Matches by `option.value`. Optional.
- `label` <[string]> Matches by `option.label`. Optional. - `label` <[string]> Matches by `option.label`. Optional.

View file

@ -315,7 +315,7 @@ function extractLangs(spec) {
aliases[match[1].trim()] = match[2].trim(); aliases[match[1].trim()] = match[2].trim();
} }
return { return {
only: only ? only.split(',') : undefined, only: only ? only.split(',').map(l => l.trim()) : undefined,
aliases, aliases,
types: {}, types: {},
overrides: {} overrides: {}