Playwright.Worker (Playwright v1.65.0-rc.3)

Copy Markdown View Source

The Worker class represents a WebWorker. worker event is emitted on the page object to signal a worker creation. close event is emitted on the worker object when the worker is gone.

Page.on(page, :worker, fn worker ->
  IO.puts("Worker created: " <> Worker.url(worker))
  Worker.on(worker, :close, &IO.puts("Worker destroyed: " <> Worker.url(&1)))
end)

IO.puts("Current workers:")
for worker <- Page.workers(page), do: IO.puts("  " <> Worker.url(worker))

Since Playwright 1.8.

The examples alias the modules they use (alias Playwright.{Locator, Page}).

Events

:close

Emitted when this dedicated WebWorker is terminated.

:console

Since Playwright 1.57. Emitted when JavaScript within the worker calls one of console API methods, e.g. console.log or console.dir.

Summary

Types

An event name, see the module docs.

Options of expect_event/4, see its docs.

t()

A Worker handle. Compare handles with ==, their fields are internal.

Options of wait_for_event/3, see its docs.

Functions

Returns the return value of expression.

Like evaluate/3, but returns the value and raises on error.

Returns the return value of expression as a JSHandle.

Like evaluate_handle/3, but returns the value and raises on error.

Waits for event to fire and passes its value into the predicate function. Returns when the predicate returns truthy value. Will fail if the page is closed before the event is fired. Returns the event data value.

Like expect_event/4, but returns the value and raises on error.

Since Playwright 1.8.

Waits for event to fire and passes its value into the predicate function. Returns when the predicate returns truthy value. Will fail if the page is closed before the event is fired. Returns the event data value.

Like wait_for_event/3, but awaits the promise: Playwright.Promise.await!(wait_for_event(...)), the value or a raise.

Events

Adds an event listener for event, see the module docs for the events.

Removes an event listener added by on/3 or add_listener/3.

Adds an event listener for event, see the module docs for the events.

Adds an event listener that is removed after it is triggered once. See on/3.

Adds an event listener for event, see the module docs for the events.

Removes an event listener added by on/3 or add_listener/3.

Types

event()

@type event() :: :close | :console

An event name, see the module docs.

expect_event_options()

@type expect_event_options() ::
  [
    predicate: fun(),
    timeout: number() | :infinity,
    signal: Playwright.AbortSignal.t()
  ]
  | %{
      optional(:predicate) => fun(),
      optional(:timeout) => number() | :infinity,
      optional(:signal) => Playwright.AbortSignal.t()
    }

Options of expect_event/4, see its docs.

t()

@type t() :: %Playwright.Worker{
  conn: term(),
  guid: term(),
  initializer: term(),
  table: term(),
  type: term()
}

A Worker handle. Compare handles with ==, their fields are internal.

wait_for_event_options()

@type wait_for_event_options() ::
  [
    predicate: fun(),
    timeout: number() | :infinity,
    signal: Playwright.AbortSignal.t()
  ]
  | %{
      optional(:predicate) => fun(),
      optional(:timeout) => number() | :infinity,
      optional(:signal) => Playwright.AbortSignal.t()
    }

Options of wait_for_event/3, see its docs.

Functions

evaluate(worker, expression, arg \\ nil)

@spec evaluate(t(), String.t(), term() | nil) ::
  {:ok, term()} | {:error, Playwright.error()}

Returns the return value of expression.

If the function passed to the Playwright.Worker.evaluate/3 returns a Promise, then Playwright.Worker.evaluate/3 would wait for the promise to resolve and return its value.

If the function passed to the Playwright.Worker.evaluate/3 returns a non-Serializable value, then Playwright.Worker.evaluate/3 returns nil. Playwright also supports transferring some additional values that are not serializable by JSON: -0, NaN, Infinity, -Infinity.

Since Playwright 1.8.

Arguments

  • expression - Function to be evaluated in the worker context.
  • arg - Optional argument to pass to expression.

evaluate!(worker, expression, arg \\ nil)

@spec evaluate!(t(), String.t(), term() | nil) :: term()

Like evaluate/3, but returns the value and raises on error.

evaluate_handle(worker, expression, arg \\ nil)

@spec evaluate_handle(t(), String.t(), term() | nil) ::
  {:ok, Playwright.JSHandle.t()} | {:error, Playwright.error()}

Returns the return value of expression as a JSHandle.

The only difference between Playwright.Worker.evaluate/3 and Playwright.Worker.evaluate_handle/3 is that Playwright.Worker.evaluate_handle/3 returns JSHandle.

If the function passed to the Playwright.Worker.evaluate_handle/3 returns a Promise, then Playwright.Worker.evaluate_handle/3 would wait for the promise to resolve and return its value.

Since Playwright 1.8.

Arguments

  • expression - Function to be evaluated in the worker context.
  • arg - Optional argument to pass to expression.

evaluate_handle!(worker, expression, arg \\ nil)

@spec evaluate_handle!(t(), String.t(), term() | nil) :: Playwright.JSHandle.t()

Like evaluate_handle/3, but returns the value and raises on error.

expect_event(worker, event, action, options \\ [])

@spec expect_event(
  t(),
  event() | String.t(),
  (-> term()),
  expect_event_options() | fun()
) ::
  {:ok, term()} | {:error, Playwright.error()}

Waits for event to fire and passes its value into the predicate function. Returns when the predicate returns truthy value. Will fail if the page is closed before the event is fired. Returns the event data value.

Usage

# Start waiting for download before clicking. Note no await.
console_promise = Worker.wait_for_event(worker, :console)
Worker.evaluate!(worker, "console.log(42)")
console_message = Promise.await!(console_promise)

Since Playwright 1.57.

Arguments

  • event - Event name, same one typically passed into Playwright.Worker.on/3.
  • action - A function that performs the action triggering the wait. It runs once the wait is set up; its result is ignored and what it raises propagates.

Options

A function in place of the options is the :predicate option.

expect_event!(worker, event, action, options \\ [])

@spec expect_event!(
  t(),
  event() | String.t(),
  (-> term()),
  expect_event_options() | fun()
) :: term()

Like expect_event/4, but returns the value and raises on error.

url(worker)

@spec url(t()) :: String.t()

Since Playwright 1.8.

wait_for_event(worker, event, options \\ [])

@spec wait_for_event(t(), event() | String.t(), wait_for_event_options() | fun()) ::
  Playwright.Promise.t()

Waits for event to fire and passes its value into the predicate function. Returns when the predicate returns truthy value. Will fail if the page is closed before the event is fired. Returns the event data value.

Usage

# Start waiting for download before clicking. Note no await.
console_promise = Worker.wait_for_event(worker, :console)
Worker.evaluate!(worker, "console.log(42)")
console_message = Promise.await!(console_promise)

Since Playwright 1.57.

Arguments

Options

A function in place of the options is the :predicate option.

Returns a Playwright.Promise at once, with the wait already set up. Start it before the action that triggers it and await it after with Playwright.Promise.await/1:

promise = Playwright.Worker.wait_for_event(worker, event)
Playwright.Locator.click!(button)
value = Playwright.Promise.await!(promise)

The callback form expect_event/4 runs the action:

value = Playwright.Worker.expect_event!(worker, event, fn -> Playwright.Locator.click!(button) end)

wait_for_event!(worker, event, options \\ [])

@spec wait_for_event!(t(), event() | String.t(), wait_for_event_options() | fun()) ::
  term()

Like wait_for_event/3, but awaits the promise: Playwright.Promise.await!(wait_for_event(...)), the value or a raise.

Start waiting before the action

This waits from the time it is called, so it misses what the code before it triggered. Start the wait with wait_for_event/3 before the action and await it after, or use the callback form expect_event!/4:

promise = Playwright.Worker.wait_for_event(worker, event)
Playwright.Locator.click!(button)
value = Playwright.Promise.await!(promise)
value = Playwright.Worker.expect_event!(worker, event, fn -> Playwright.Locator.click!(button) end)

Events

add_listener(worker, event, listener)

@spec add_listener(t(), :close, (t() -> term())) :: t()
@spec add_listener(t(), :console, (Playwright.ConsoleMessage.t() -> term())) :: t()
@spec add_listener(t(), String.t(), (term() -> term())) :: t()

Adds an event listener for event, see the module docs for the events.

off(worker, event, listener)

@spec off(t(), :close, (t() -> term())) :: t()
@spec off(t(), :console, (Playwright.ConsoleMessage.t() -> term())) :: t()
@spec off(t(), String.t(), (term() -> term())) :: t()

Removes an event listener added by on/3 or add_listener/3.

on(worker, event, listener)

@spec on(t(), :close, (t() -> term())) :: t()
@spec on(t(), :console, (Playwright.ConsoleMessage.t() -> term())) :: t()
@spec on(t(), String.t(), (term() -> term())) :: t()

Adds an event listener for event, see the module docs for the events.

once(worker, event, listener)

@spec once(t(), :close, (t() -> term())) :: t()
@spec once(t(), :console, (Playwright.ConsoleMessage.t() -> term())) :: t()
@spec once(t(), String.t(), (term() -> term())) :: t()

Adds an event listener that is removed after it is triggered once. See on/3.

prepend_listener(worker, event, listener)

@spec prepend_listener(t(), :close, (t() -> term())) :: t()
@spec prepend_listener(t(), :console, (Playwright.ConsoleMessage.t() -> term())) ::
  t()
@spec prepend_listener(t(), String.t(), (term() -> term())) :: t()

Adds an event listener for event, see the module docs for the events.

remove_listener(worker, event, listener)

@spec remove_listener(t(), :close, (t() -> term())) :: t()
@spec remove_listener(t(), :console, (Playwright.ConsoleMessage.t() -> term())) :: t()
@spec remove_listener(t(), String.t(), (term() -> term())) :: t()

Removes an event listener added by on/3 or add_listener/3.