Skip to content

JSHandle ​

Added in: v1.8

JSHandle represents an in-page JavaScript object. JSHandles can be created with the page.evaluateHandle() method.

java
JSHandle windowHandle = page.evaluateHandle("() => window");
// ...

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.evalOnSelector(), page.evaluate() and page.evaluateHandle() methods.

Methods ​

jsHandle.asElement() ​

Added in: v1.8

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

Returns

  • null | ElementHandle

jsHandle.dispose() ​

Added in: v1.8

The jsHandle.dispose method stops referencing the element handle.

jsHandle.evaluate() ​

Added in: v1.8

Returns the return value of expression.

This method passes this handle as the first argument to expression.

If expression returns a [Promise], then handle.evaluate would wait for the promise to resolve and return its value.

Usage

java
ElementHandle tweetHandle = page.querySelector(".tweet .retweets");
assertEquals("10 retweets", tweetHandle.evaluate("node => node.innerText"));

Arguments

  • expression string

    JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.

  • arg EvaluationArgument (optional)

    Optional argument to pass to expression.

Returns

  • Serializable

jsHandle.evaluateHandle() ​

Added in: v1.8

Returns the return value of expression as a JSHandle.

This method passes this handle as the first argument to expression.

The only difference between jsHandle.evaluate and jsHandle.evaluateHandle is that jsHandle.evaluateHandle returns 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() for more details.

Arguments

  • expression string

    JavaScript expression to be evaluated in the browser context. If the expression evaluates to a function, the function is automatically invoked.

  • arg EvaluationArgument (optional)

    Optional argument to pass to expression.

Returns

  • JSHandle

jsHandle.getProperties() ​

Added in: v1.8

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

Usage

java
JSHandle handle = page.evaluateHandle("() => ({ window, document })");
Map<String, JSHandle> properties = handle.getProperties();
JSHandle windowHandle = properties.get("window");
JSHandle documentHandle = properties.get("document");
handle.dispose();

Returns

  • Map<string, JSHandle>

jsHandle.getProperty() ​

Added in: v1.8

Fetches a single property from the referenced object.

Arguments

  • propertyName string

    property to get

Returns

  • JSHandle

jsHandle.jsonValue() ​

Added in: v1.8

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

INFO

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.

Returns

  • Serializable

Released under the Apache 2.0 License.