Skip to content

Commit

Permalink
Doc: deprecation notices and whitespace cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
@coreyti
coreyti committed Aug 13, 2024
1 parent be98b71 commit 7b7869b
Showing 1 changed file with 32 additions and 35 deletions.
67 changes: 32 additions & 35 deletions lib/playwright/locator.ex
View file
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,7 @@ defmodule Playwright.Locator do
## Arguments
| key/name | type | | description |
| key/name | type | | description |
| ---------------- | ------ | --------------------------------- | ----------- |
| `:button` | option | `:left`, `:right` or `:middle` | `(default: :left)` |
| `:click_count` | option | `number()` | See [MDN: `UIEvent.detail`](https://developer.mozilla.org/en-US/docs/Web/API/UIEvent/detail) `(default: 1)` |
Expand Down Expand Up @@ -334,7 +334,7 @@ defmodule Playwright.Locator do
## Arguments
| key/name | type | | description |
| key/name | type | | description |
| ---------------- | ------ | --------------------------------- | ----------- |
| `:button` | option | `:left`, `:right` or `:middle` | `(default: :left)` |
| `:delay` | option | `number() ` | Time to wait between keydown and keyup in milliseconds. `(default: 0)` |
Expand Down Expand Up @@ -391,7 +391,7 @@ defmodule Playwright.Locator do
## Arguments
| key/name | type | | description |
| key/name | type | | description |
| ---------------- | ------ | ----------------------- | ----------- |
| `type` | param | `atom()` or `binary()` | DOM event type: `:click`, `:dragstart`, etc. |
| `event_init` | param | `evaluation_argument()` | Optional event-specific initialization properties. |
Expand Down Expand Up @@ -424,10 +424,11 @@ defmodule Playwright.Locator do
## Arguments
| key/name | type | | description |
| key/name | type | | description |
| ---------- | ------ | ---------- | ----------- |
| `:timeout` | option | `number()` | Maximum time in milliseconds. Pass `0` to disable timeout. The default value can be changed by using the `Playwright.BrowserContext.set_default_timeout/2` or `Playwright.Page.set_default_timeout/2` functions. `(default: 30 seconds)` |
"""
@doc deprecated: "Discouraged: Prefer using Locators and web assertions over ElementHandles because latter are inherently racy."
@spec element_handle(t(), options()) :: ElementHandle.t() | {:error, Channel.Error.t()}
def element_handle(%Locator{} = locator, options \\ %{}) do
options = Map.merge(%{strict: true, state: "attached"}, options)
Expand All @@ -444,6 +445,7 @@ defmodule Playwright.Locator do
- `[Playwright.ElementHandle.t()]`
"""
@doc deprecated: "Discouraged: Prefer using Locators and web assertions over ElementHandles because latter are inherently racy."
@spec element_handles(t()) :: [ElementHandle.t()]
def element_handles(locator) do
Frame.query_selector_all(locator.frame, locator.selector)
Expand All @@ -460,7 +462,7 @@ defmodule Playwright.Locator do
## Arguments
| key/name | type | | description |
| key/name | type | | description |
| ------------ | ------ | ---------- | ----------- |
| `expression` | param | `binary()` | JavaScript expression to be evaluated in the browser context. If it looks like a function declaration, it is interpreted as a function. Otherwise, evaluated as an expression. |
| `arg` | param | `any()` | Argument to pass to `expression` `(optional)` |
Expand All @@ -469,10 +471,6 @@ defmodule Playwright.Locator do
@spec evaluate(t(), binary(), any(), options()) :: serializable()
def evaluate(locator, expression, arg \\ nil, options \\ %{})

require Logger

# NOTE: need to do all of the map-like things before a plain `map()`,
# then do `map()`, then do anything else.
def evaluate(%Locator{} = locator, expression, arg, options)
when is_struct(arg, ElementHandle) do
with_element(locator, options, fn handle ->
Expand Down Expand Up @@ -533,7 +531,7 @@ defmodule Playwright.Locator do
## Arguments
| key/name | type | | description |
| key/name | type | | description |
| ------------ | ------ | ---------- | ----------- |
| `expression` | param | `binary()` | JavaScript expression to be evaluated in the browser context. If it looks like a function declaration, it is interpreted as a function. Otherwise, evaluated as an expression. |
| `arg` | param | `any()` | Argument to pass to `expression` `(optional)` |
Expand Down Expand Up @@ -593,7 +591,7 @@ defmodule Playwright.Locator do
## Arguments
| key/name | type | | description |
| key/name | type | | description |
| ---------------- | ------ | ----------- | ----------- |
| `value` | param | `binary()` | Value to fill for the `<input>`, `<textarea>` or `[contenteditable]` element |
| `:force` | option | `boolean()` | Whether to bypass the actionability checks. `(default: false)` |
Expand Down Expand Up @@ -626,7 +624,7 @@ defmodule Playwright.Locator do
## Arguments
| key/name | type | | description |
| key/name | type | | description |
| ---------- | ------ | ---------- | ----------- |
| `:timeout` | option | `number()` | Maximum time in milliseconds. Pass `0` to disable timeout. The default value can be changed by using the `Playwright.BrowserContext.set_default_timeout/2` or `Playwright.Page.set_default_timeout/2` functions. `(default: 30 seconds)` |
"""
Expand Down Expand Up @@ -703,7 +701,7 @@ defmodule Playwright.Locator do
## Arguments
| key/name | type | | description |
| key/name | type | | description |
| ---------------- | ------ | --------------------------------- | ----------- |
| `selector` | param | `binary()` | A selector to search for an element. If there are multiple elements satisfying the selector, the first will be used. See "working with selectors (guide)" for more details. |
| `:force` | option | `boolean()` | Whether to bypass the actionability checks. `(default: false)` |
Expand All @@ -723,7 +721,7 @@ defmodule Playwright.Locator do
## Arguments
| key/name | type | | description |
| key/name | type | | description |
| ---------- | ------ | ---------- | ----------- |
| `:timeout` | option | `number()` | Maximum time in milliseconds. Pass `0` to disable timeout. The default value can be changed by using the `Playwright.BrowserContext.set_default_timeout/2` or `Playwright.Page.set_default_timeout/2` functions. `(default: 30 seconds)` |
"""
Expand All @@ -737,7 +735,7 @@ defmodule Playwright.Locator do
## Arguments
| key/name | type | | description |
| key/name | type | | description |
| ---------- | ------ | ---------- | ----------- |
| `:timeout` | option | `number()` | Maximum time in milliseconds. Pass `0` to disable timeout. The default value can be changed by using the `Playwright.BrowserContext.set_default_timeout/2` or `Playwright.Page.set_default_timeout/2` functions. `(default: 30 seconds)` |
"""
Expand All @@ -754,7 +752,7 @@ defmodule Playwright.Locator do
## Arguments
| key/name | type | | description |
| key/name | type | | description |
| ---------- | ------ | ---------- | ----------- |
| `:timeout` | option | `number()` | Maximum time in milliseconds. Pass `0` to disable timeout. The default value can be changed by using the `Playwright.BrowserContext.set_default_timeout/2` or `Playwright.Page.set_default_timeout/2` functions. `(default: 30 seconds)` |
"""
Expand All @@ -770,7 +768,7 @@ defmodule Playwright.Locator do
## Arguments
| key/name | type | | description |
| key/name | type | | description |
| ---------- | ------ | ---------- | ----------- |
| `:timeout` | option | `number()` | Maximum time in milliseconds. Pass `0` to disable timeout. The default value can be changed by using the `Playwright.BrowserContext.set_default_timeout/2` or `Playwright.Page.set_default_timeout/2` functions. `(default: 30 seconds)` |
"""
Expand All @@ -784,7 +782,7 @@ defmodule Playwright.Locator do
## Arguments
| key/name | type | | description |
| key/name | type | | description |
| ---------- | ------ | ---------- | ----------- |
| `:timeout` | option | `number()` | Maximum time in milliseconds. Pass `0` to disable timeout. The default value can be changed by using the `Playwright.BrowserContext.set_default_timeout/2` or `Playwright.Page.set_default_timeout/2` functions. `(default: 30 seconds)` |
"""
Expand All @@ -798,7 +796,7 @@ defmodule Playwright.Locator do
## Arguments
| key/name | type | | description |
| key/name | type | | description |
| ---------- | ------ | ---------- | ----------- |
| `:timeout` | option | `number()` | Maximum time in milliseconds. Pass `0` to disable timeout. The default value can be changed by using the `Playwright.BrowserContext.set_default_timeout/2` or `Playwright.Page.set_default_timeout/2` functions. `(default: 30 seconds)` |
"""
Expand All @@ -812,7 +810,7 @@ defmodule Playwright.Locator do
## Arguments
| key/name | type | | description |
| key/name | type | | description |
| ---------- | ------ | ---------- | ----------- |
| `:timeout` | option | `number()` | Maximum time in milliseconds. Pass `0` to disable timeout. The default value can be changed by using the `Playwright.BrowserContext.set_default_timeout/2` or `Playwright.Page.set_default_timeout/2` functions. `(default: 30 seconds)` |
"""
Expand All @@ -826,7 +824,7 @@ defmodule Playwright.Locator do
## Arguments
| key/name | type | | description |
| key/name | type | | description |
| ---------- | ------ | ---------- | ----------- |
| `:timeout` | option | `number()` | Maximum time in milliseconds. Pass `0` to disable timeout. The default value can be changed by using the `Playwright.BrowserContext.set_default_timeout/2` or `Playwright.Page.set_default_timeout/2` functions. `(default: 30 seconds)` |
"""
Expand All @@ -840,7 +838,7 @@ defmodule Playwright.Locator do
## Arguments
| key/name | type | | description |
| key/name | type | | description |
| ---------- | ------ | ---------- | ----------- |
| `:timeout` | option | `number()` | Maximum time in milliseconds. Pass `0` to disable timeout. The default value can be changed by using the `Playwright.BrowserContext.set_default_timeout/2` or `Playwright.Page.set_default_timeout/2` functions. `(default: 30 seconds)` |
"""
Expand Down Expand Up @@ -928,7 +926,7 @@ defmodule Playwright.Locator do
## Arguments
| key/name | type | | description |
| key/name | type | | description |
| ---------------- | ------ | --------------- | ----------- |
| `key` | param | `binary()` | Name of the key to press or a character to generate, such as `ArrowLeft` or `a`. |
| `:delay` | option | `number()` | Time to wait between `mousedown` and `mouseup` in milliseconds. `(default: 0)` |
Expand All @@ -952,7 +950,7 @@ defmodule Playwright.Locator do
## Arguments
| key/name | type | | description |
| key/name | type | | description |
| ------------------ | ------ | ----------------- | ----------- |
| `:omit_background` | option | `boolean()` | Hides default white background and allows capturing screenshots with transparency. Not applicable to jpeg images. `(default: false)` |
| `:path` | option | `binary()` | The file path to which to save the image. The screenshot type will be inferred from file extension. If path is a relative path, then it is resolved relative to the current working directory. If no path is provided, the image won't be saved to the disk. |
Expand All @@ -974,7 +972,7 @@ defmodule Playwright.Locator do
## Arguments
| key/name | type | | description |
| key/name | type | | description |
| ---------------- | ------ | --------------- | ----------- |
| `:timeout` | option | `number()` | Maximum time in milliseconds. Pass `0` to disable timeout. The default value can be changed by using the `Playwright.BrowserContext.set_default_timeout/2` or `Playwright.Page.set_default_timeout/2` functions. `(default: 30 seconds)` |
"""
Expand Down Expand Up @@ -1024,7 +1022,7 @@ defmodule Playwright.Locator do
## Arguments
| key/name | type | | description |
| key/name | type | | description |
| ---------------- | ------ | --------------- | ----------- |
| `values` | param | `any()` | Options to select. |
| `:force` | option | `boolean()` | Whether to bypass the actionability checks. `(default: false)` |
Expand Down Expand Up @@ -1057,7 +1055,7 @@ defmodule Playwright.Locator do
## Arguments
| key/name | type | | description |
| key/name | type | | description |
| ---------------- | ------ | --------------- | ----------- |
| `:force` | option | `boolean()` | Whether to bypass the actionability checks. `(default: false)` |
| `:timeout` | option | `number()` | Maximum time in milliseconds. Pass `0` to disable timeout. The default value can be changed by using the `Playwright.BrowserContext.set_default_timeout/2` or `Playwright.Page.set_default_timeout/2` functions. `(default: 30 seconds)` |
Expand Down Expand Up @@ -1092,7 +1090,7 @@ defmodule Playwright.Locator do
## Arguments
| key/name | type | | description |
| key/name | type | | description |
| ---------------- | ------ | --------------- | ----------- |
| `checked` | param | `boolean()` | Whether to check or uncheck the checkbox. |
| `:force` | option | `boolean()` | Whether to bypass the actionability checks. `(default: false)` |
Expand Down Expand Up @@ -1124,7 +1122,7 @@ defmodule Playwright.Locator do
## Arguments
| key/name | type | | description |
| key/name | type | | description |
| ---------------- | ------ | --------------- | ----------- |
| `files` | param | `any()` | ... |
| `:no_wait_after` | option | `boolean()` | Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. `(default: false)` |
Expand Down Expand Up @@ -1170,7 +1168,7 @@ defmodule Playwright.Locator do
## Arguments
| key/name | type | | description |
| key/name | type | | description |
| ---------------- | ------ | --------------------------------- | ----------- |
| `:force` | option | `boolean()` | Whether to bypass the actionability checks. `(default: false)` |
| `:modifiers` | option | `[:alt, :control, :meta, :shift]` | Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. |
Expand All @@ -1190,7 +1188,7 @@ defmodule Playwright.Locator do
## Arguments
| key/name | type | | description |
| key/name | type | | description |
| ---------- | ------ | ---------- | ----------- |
| `:timeout` | option | `number()` | Maximum time in milliseconds. Pass `0` to disable timeout. The default value can be changed by using the `Playwright.BrowserContext.set_default_timeout/2` or `Playwright.Page.set_default_timeout/2` functions. `(default: 30 seconds)` |
"""
Expand All @@ -1208,7 +1206,7 @@ defmodule Playwright.Locator do
## Arguments
| key/name | type | | description |
| key/name | type | | description |
| ---------------- | ------ | ----------- | ----------- |
| `text` | param | `binary()` | Text to type into a focused element. |
| `:delay` | option | `number()` | Time to wait between `mousedown` and `mouseup` in milliseconds. `(default: 0)` |
Expand Down Expand Up @@ -1245,7 +1243,7 @@ defmodule Playwright.Locator do
## Arguments
| key/name | type | | description |
| key/name | type | | description |
| ---------------- | ------ | --------------- | ----------- |
| `:force` | option | `boolean()` | Whether to bypass the actionability checks. `(default: false)` |
| `:no_wait_after` | option | `boolean()` | Actions that initiate navigations are waiting for these navigations to happen and for pages to start loading. You can opt out of waiting via setting this flag. You would only need this option in the exceptional cases such as navigating to inaccessible pages. `(default: false)` |
Expand Down Expand Up @@ -1287,8 +1285,7 @@ defmodule Playwright.Locator do
## Example
...
"""

# const orderSent = page.locator('#order-sent');
Expand Down

0 comments on commit 7b7869b

Please sign in to comment.