JSHandle

JSHandleは、ページ内のJavaScriptオブジェクトを表します。JSHandleは、Page.evaluateHandle() メソッドで作成できます。

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

JSHandleは、JSHandle.dispose() でハンドルが公開されない限り、参照されるJavaScriptオブジェクトがガベージコレクションされるのを防ぎます。JSHandleは、その元のフレームがナビゲートされたり、親コンテキストが破棄されたりすると自動的に破棄されます。

JSHandleインスタンスは、Page.evalOnSelector()、Page.evaluate()、およびPage.evaluateHandle() メソッドの引数として使用できます。

---

メソッド

asElement

v1.9より前に追加 jsHandle.asElement

オブジェクトハンドルがElementHandleのインスタンスである場合、nullまたはオブジェクトハンドル自体を返します。

使用法

JSHandle.asElement();

戻り値

• null | ElementHandle#

---

dispose

v1.9より前に追加 jsHandle.dispose

jsHandle.disposeメソッドは、要素ハンドルへの参照を停止します。

使用法

JSHandle.dispose();

戻り値

• void#

---

evaluate

v1.9より前に追加 jsHandle.evaluate

式の戻り値を返します。

このメソッドは、このハンドルを式の最初の引数として渡します。

式がPromiseを返す場合、handle.evaluateはPromiseが解決されるのを待ち、その値を返します。

使用法

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

引数

• expression String#

  ブラウザーコンテキストで評価される JavaScript 式。式が関数に評価される場合、その関数は自動的に呼び出されます。

• arg EvaluationArgument (オプション)#

  式に渡すオプションの引数です。

戻り値

• Object#

---

evaluateHandle

v1.9より前に追加 jsHandle.evaluateHandle

式の戻り値をJSHandleとして返します。

このメソッドは、このハンドルを式の最初の引数として渡します。

jsHandle.evaluateとjsHandle.evaluateHandleの唯一の違いは、jsHandle.evaluateHandleがJSHandleを返すことです。

jsHandle.evaluateHandleに渡された関数がPromiseを返す場合、jsHandle.evaluateHandleはそのPromiseが解決されるのを待ってその値を返します。

詳細については、Page.evaluateHandle() を参照してください。

使用法

JSHandle.evaluateHandle(expression);
JSHandle.evaluateHandle(expression, arg);

引数

• expression String#

  ブラウザーコンテキストで評価される JavaScript 式。式が関数に評価される場合、その関数は自動的に呼び出されます。

• arg EvaluationArgument (オプション)#

  式に渡すオプションの引数です。

戻り値

• JSHandle#

---

getProperties

v1.9より前に追加 jsHandle.getProperties

このメソッドは、キーとして自身のプロパティ名、値としてプロパティ値のJSHandleインスタンスを持つマップを返します。

使用法

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

戻り値

• Map<String, JSHandle>#

---

getProperty

v1.9より前に追加 jsHandle.getProperty

参照されているオブジェクトから単一のプロパティを取得します。

使用法

JSHandle.getProperty(propertyName);

引数

• propertyName String#

  取得するプロパティ

戻り値

• JSHandle#

---

jsonValue

v1.9より前に追加 jsHandle.jsonValue

オブジェクトのJSON表現を返します。オブジェクトにtoJSON関数がある場合、それは呼び出されません。

注

参照されているオブジェクトが文字列化できない場合、このメソッドは空のJSONオブジェクトを返します。オブジェクトに循環参照がある場合、エラーをスローします。

使用法

JSHandle.jsonValue();

戻り値

• Object#