Skip to content

Commit 0ae5cbd

Browse files
yury-syury-s
authored
docs: alias bullets for port-specific Object struct names (#40122)
1 parent dfd8f1e commit 0ae5cbd

16 files changed

Lines changed: 114 additions & 43 deletions

‎docs/src/api/class-apiresponse.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,9 @@ An object with all the response HTTP headers associated with this response.
5757

5858
## method: APIResponse.headersArray
5959
* since: v1.16
60-
- returns: <[Array]<[Object=Header]>>
60+
- returns: <[Array]<[Object]>>
61+
- alias-csharp: Header
62+
- alias-java: HttpHeader
6163
- `name` <[string]> Name of the header.
6264
- `value` <[string]> Value of the header.
6365

‎docs/src/api/class-browser.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -298,6 +298,7 @@ testing frameworks should explicitly create [`method: Browser.newContext`] follo
298298
## async method: Browser.bind
299299
* since: v1.59
300300
- returns: <[Object]>
301+
- alias: BindResult
301302
- `endpoint` <[string]>
302303

303304
Binds the browser to a named pipe or web socket, making it available for other clients to connect to.

‎docs/src/api/class-browsercontext.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -331,6 +331,7 @@ await context.AddCookiesAsync(new[] { cookie1, cookie2 });
331331
### param: BrowserContext.addCookies.cookies
332332
* since: v1.8
333333
- `cookies` <[Array]<[Object]>>
334+
- alias-java: Cookie
334335
- `name` <[string]>
335336
- `value` <[string]>
336337
- `url` ?<[string]> Either `url` or both `domain` and `path` are required. Optional.
@@ -569,7 +570,9 @@ The default browser context cannot be closed.
569570

570571
## async method: BrowserContext.cookies
571572
* since: v1.8
572-
- returns: <[Array]<[Object=BrowserContextCookiesResult]>>
573+
- returns: <[Array]<[Object]>>
574+
- alias-csharp: BrowserContextCookiesResult
575+
- alias-java: Cookie
573576
- `name` <[string]>
574577
- `value` <[string]>
575578
- `domain` <[string]>
@@ -730,6 +733,7 @@ Name of the function on the window object.
730733
### param: BrowserContext.exposeBinding.callback
731734
* since: v1.8
732735
- `callback` <[function]>
736+
- alias-java: BindingCallback
733737

734738
Callback function that will be called in the Playwright's context.
735739

@@ -929,6 +933,7 @@ Name of the function on the window object.
929933
### param: BrowserContext.exposeFunction.callback
930934
* since: v1.8
931935
- `callback` <[function]>
936+
- alias-java: FunctionCallback
932937

933938
Callback function that will be called in the Playwright's context.
934939

@@ -1465,6 +1470,7 @@ its geolocation.
14651470
### param: BrowserContext.setGeolocation.geolocation
14661471
* since: v1.8
14671472
- `geolocation` <[null]|[Object]>
1473+
- alias-java: Geolocation
14681474
- `latitude` <[float]> Latitude between -90 and 90.
14691475
- `longitude` <[float]> Longitude between -180 and 180.
14701476
- `accuracy` ?<[float]> Non-negative accuracy value. Defaults to `0`.

‎docs/src/api/class-debugger.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,10 @@ Emitted when the debugger pauses or resumes.
1111

1212
## method: Debugger.pausedDetails
1313
* since: v1.59
14-
- returns: <[null]|[Object=DebuggerPausedDetails]>
14+
- returns: <[null]|[Object]>
15+
- alias: DebuggerPausedDetails
1516
- `location` <[Object]>
17+
- alias-java: Location
1618
- `file` <[string]>
1719
- `line` ?<[int]>
1820
- `column` ?<[int]>
@@ -47,6 +49,7 @@ Resumes script execution and pauses when an action originates from the given sou
4749
### param: Debugger.runTo.location
4850
* since: v1.59
4951
- `location` <[Object]>
52+
- alias-java: Location
5053
- `file` <[string]>
5154
- `line` ?<[int]>
5255
- `column` ?<[int]>

‎docs/src/api/class-elementhandle.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,9 @@ await locator.ClickAsync();
108108

109109
## async method: ElementHandle.boundingBox
110110
* since: v1.8
111-
- returns: <[null]|[Object=ElementHandleBoundingBoxResult]>
111+
- returns: <[null]|[Object]>
112+
- alias-csharp: ElementHandleBoundingBoxResult
113+
- alias-java: BoundingBox
112114
- `x` <[float]> the x coordinate of the element in pixels.
113115
- `y` <[float]> the y coordinate of the element in pixels.
114116
- `width` <[float]> the width of the element in pixels.

‎docs/src/api/class-formdata.md‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,9 @@ Field name.
6868

6969
### param: FormData.append.value
7070
* since: v1.44
71-
- `value` <[string]|[boolean]|[int]|[Path]|[Object=FilePayload]>
71+
- `value` <[string]|[boolean]|[int]|[Path]|[Object]>
72+
- alias-csharp: FilePayload
73+
- alias-java: FilePayload
7274
- `name` <[string]> File name
7375
- `mimeType` <[string]> File type
7476
- `buffer` <[Buffer]> File content
@@ -78,7 +80,8 @@ Field value.
7880
### param: FormData.append.value
7981
* since: v1.44
8082
* langs: csharp
81-
- `value` <[string]|[boolean]|[int]|[Object=FilePayload]>
83+
- `value` <[string]|[boolean]|[int]|[Object]>
84+
- alias-csharp: FilePayload
8285
- `name` <[string]> File name
8386
- `mimeType` <[string]> File type
8487
- `buffer` <[Buffer]> File content
@@ -135,7 +138,9 @@ Field name.
135138

136139
### param: FormData.set.value
137140
* since: v1.18
138-
- `value` <[string]|[boolean]|[int]|[Path]|[Object=FilePayload]>
141+
- `value` <[string]|[boolean]|[int]|[Path]|[Object]>
142+
- alias-csharp: FilePayload
143+
- alias-java: FilePayload
139144
- `name` <[string]> File name
140145
- `mimeType` <[string]> File type
141146
- `buffer` <[Buffer]> File content
@@ -145,7 +150,8 @@ Field value.
145150
### param: FormData.set.value
146151
* since: v1.18
147152
* langs: csharp
148-
- `value` <[string]|[boolean]|[int]|[Object=FilePayload]>
153+
- `value` <[string]|[boolean]|[int]|[Object]>
154+
- alias-csharp: FilePayload
149155
- `name` <[string]> File name
150156
- `mimeType` <[string]> File type
151157
- `buffer` <[Buffer]> File content

‎docs/src/api/class-locator.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,9 @@ Calls [blur](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/blur)
242242

243243
## async method: Locator.boundingBox
244244
* since: v1.14
245-
- returns: <[null]|[Object=LocatorBoundingBoxResult]>
245+
- returns: <[null]|[Object]>
246+
- alias-csharp: LocatorBoundingBoxResult
247+
- alias-java: BoundingBox
246248
- `x` <[float]> the x coordinate of the element in pixels.
247249
- `y` <[float]> the y coordinate of the element in pixels.
248250
- `width` <[float]> the width of the element in pixels.

‎docs/src/api/class-page.md‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1829,6 +1829,7 @@ Name of the function on the window object.
18291829
### param: Page.exposeBinding.callback
18301830
* since: v1.8
18311831
- `callback` <[function]>
1832+
- alias-java: BindingCallback
18321833

18331834
Callback function that will be called in the Playwright's context.
18341835

@@ -2030,6 +2031,7 @@ Name of the function on the window object
20302031
### param: Page.exposeFunction.callback
20312032
* since: v1.8
20322033
- `callback` <[function]>
2034+
- alias-java: FunctionCallback
20332035

20342036
Callback function which will be called in Playwright's context.
20352037

@@ -3005,6 +3007,7 @@ Paper margins, defaults to none.
30053007
* since: v1.8
30063008
* langs: csharp, java
30073009
- `margin` <[Object]>
3010+
- alias-java: Margin
30083011
- `top` ?<[string]> Top margin, accepts values labeled with units. Defaults to `0`.
30093012
- `right` ?<[string]> Right margin, accepts values labeled with units. Defaults to `0`.
30103013
- `bottom` ?<[string]> Bottom margin, accepts values labeled with units. Defaults to `0`.
@@ -4460,7 +4463,9 @@ Video object associated with this page. Can be used to access the video file whe
44604463

44614464
## method: Page.viewportSize
44624465
* since: v1.8
4463-
- returns: <[null]|[Object=PageViewportSizeResult]>
4466+
- returns: <[null]|[Object]>
4467+
- alias-csharp: PageViewportSizeResult
4468+
- alias-java: ViewportSize
44644469
- `width` <[int]> page width in pixels.
44654470
- `height` <[int]> page height in pixels.
44664471

‎docs/src/api/class-request.md‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,9 @@ You can use [`method: Request.allHeaders`] for complete list of headers that inc
113113

114114
## async method: Request.headersArray
115115
* since: v1.15
116-
- returns: <[Array]<[Object=Header]>>
116+
- returns: <[Array]<[Object]>>
117+
- alias-csharp: Header
118+
- alias-java: HttpHeader
117119
- `name` <[string]> Name of the header.
118120
- `value` <[string]> Value of the header.
119121

@@ -310,7 +312,9 @@ Requests originated in a Service Worker do not have a [`method: Request.frame`]
310312

311313
## async method: Request.sizes
312314
* since: v1.15
313-
- returns: <[Object=RequestSizesResult]>
315+
- returns: <[Object]>
316+
- alias-csharp: RequestSizesResult
317+
- alias-java: Sizes
314318
- `requestBodySize` <[int]> Size of the request body (POST data payload) in bytes. Set to 0 if there was no body.
315319
- `requestHeadersSize` <[int]> Total number of bytes from the start of the HTTP request message until (and including) the double CRLF before the body.
316320
- `responseBodySize` <[int]> Size of the received response body (encoded) in bytes.
@@ -320,7 +324,9 @@ Returns resource size information for given request.
320324

321325
## method: Request.timing
322326
* since: v1.8
323-
- returns: <[Object=RequestTimingResult]>
327+
- returns: <[Object]>
328+
- alias-csharp: RequestTimingResult
329+
- alias-java: Timing
324330
- `startTime` <[float]> Request start time in milliseconds elapsed since January 1, 1970 00:00:00 UTC
325331
- `domainLookupStart` <[float]> Time immediately before the browser starts the domain name lookup for the
326332
resource. The value is given in milliseconds relative to `startTime`, -1 if not available.

‎docs/src/api/class-response.md‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,9 @@ You can use [`method: Response.allHeaders`] for complete list of headers that in
4848

4949
## async method: Response.headersArray
5050
* since: v1.15
51-
- returns: <[Array]<[Object=Header]>>
51+
- returns: <[Array]<[Object]>>
52+
- alias-csharp: Header
53+
- alias-java: HttpHeader
5254
- `name` <[string]> Name of the header.
5355
- `value` <[string]> Value of the header.
5456

@@ -118,7 +120,9 @@ Returns the matching [Request] object.
118120

119121
## async method: Response.securityDetails
120122
* since: v1.13
121-
- returns: <[null]|[Object=ResponseSecurityDetailsResult]>
123+
- returns: <[null]|[Object]>
124+
- alias-csharp: ResponseSecurityDetailsResult
125+
- alias-java: SecurityDetails
122126
- `issuer` ?<[string]> Common Name component of the Issuer field.
123127
from the certificate. This should only be used for informational purposes. Optional.
124128
- `protocol` ?<[string]> The specific TLS protocol used. (e.g. `TLS 1.3`). Optional.
@@ -133,7 +137,9 @@ Returns SSL and other security information.
133137

134138
## async method: Response.serverAddr
135139
* since: v1.13
136-
- returns: <[null]|[Object=ResponseServerAddrResult]>
140+
- returns: <[null]|[Object]>
141+
- alias-csharp: ResponseServerAddrResult
142+
- alias-java: ServerAddr
137143
- `ipAddress` <[string]> IPv4 or IPV6 address of the server.
138144
- `port` <[int]>
139145

0 commit comments

Comments
 (0)