module Playwright::JSHandle

Overview

JSHandle represents an in-page JavaScript object. JSHandles can be created with the page.evaluateHandle(pageFunction[, arg]) method.

JSHandle prevents the referenced JavaScript object being garbage collected unless the handle is exposed with jsHandle.dispose(). JSHandles are auto-disposed when their origin frame gets navigated or the parent context gets destroyed. JSHandle instances can be used as an argument in page.$eval(selector, pageFunction[, arg]), page.evaluate(pageFunction[, arg]) and page.evaluateHandle(pageFunction[, arg]) methods.

Direct including types

Defined in:

playwright/jshandle.cr

Instance Method Summary

Instance Method Detail

abstract def as_element : ElementHandle | Nil #

Returns either null or the object handle itself, if the object handle is an instance of ElementHandle.


[View source]
abstract def dispose : Nil #

The jsHandle.dispose method stops referencing the element handle.


[View source]
abstract def evaluate(page_function : String, arg : Array(Any) | Nil) : Any #

Returns the return value of pageFunction This method passes this handle as the first argument to pageFunction. If pageFunction returns a Promise, then handle.evaluate would wait for the promise to resolve and return its value. Examples:


[View source]
def evaluate(page_function : String) : Any #

[View source]
def evaluate(page_function : String, *arg : Any) : Any #

[View source]
abstract def evaluate_handle(page_function : String, arg : Array(Any) | Nil) : JSHandle #

Returns the return value of pageFunction as in-page object (JSHandle). This method passes this handle as the first argument to pageFunction. The only difference between jsHandle.evaluate and jsHandle.evaluateHandle is that jsHandle.evaluateHandle returns in-page object (JSHandle). If the function passed to the jsHandle.evaluateHandle returns a Promise, then jsHandle.evaluateHandle would wait for the promise to resolve and return its value. See page.evaluateHandle(pageFunction[, arg]) for more details.


[View source]
def evaluate_handle(page_function : String) : JSHandle #

[View source]
def evaluate_handle(page_function : String, *arg : Any) : JSHandle #

[View source]
abstract def get_properties : Hash(String, JSHandle) #

The method returns a map with own property names as keys and JSHandle instances for the property values.


[View source]
abstract def get_property(property_name : String) : JSHandle #

Fetches a single property from the referenced object.


[View source]
abstract def json_value : Any #

Returns a JSON representation of the object. If the object has a toJSON function, it will not be called.

NOTE The method will return an empty JSON object if the referenced object is not stringifiable. It will throw an error if the object has circular references.


[View source]