跳至主要内容

JSHandle

JSHandle 代表页面中的 JavaScript 对象。可以使用 page.evaluateHandle() 方法创建 JSHandle。

const windowHandle = await page.evaluateHandle(() => window);
// ...

JSHandle 阻止引用的 JavaScript 对象被垃圾回收,除非该句柄使用 jsHandle.dispose() 暴露。当 JSHandle 的来源帧被导航或父上下文被销毁时,JSHandle 会自动销毁。

JSHandle 实例可以用作 page.$eval()page.evaluate()page.evaluateHandle() 方法的参数。


方法

asElement

在 v1.9 之前添加 jsHandle.asElement

如果对象句柄是 ElementHandle 的实例,则返回 null 或对象句柄本身。

用法

jsHandle.asElement();

返回值


dispose

在 v1.9 之前添加 jsHandle.dispose

jsHandle.dispose 方法停止引用元素句柄。

用法

await jsHandle.dispose();

返回值


evaluate

在 v1.9 之前添加 jsHandle.evaluate

返回 pageFunction 的返回值。

此方法将此句柄作为第一个参数传递给 pageFunction

如果 pageFunction 返回一个 Promise,则 handle.evaluate 将等待 Promise 解决并返回其值。

用法

const tweetHandle = await page.$('.tweet .retweets');
expect(await tweetHandle.evaluate(node => node.innerText)).toBe('10 retweets');

参数

返回值


evaluateHandle

在 v1.9 之前添加 jsHandle.evaluateHandle

pageFunction 的返回值作为 JSHandle 返回。

此方法将此句柄作为第一个参数传递给 pageFunction

jsHandle.evaluatejsHandle.evaluateHandle 之间的唯一区别是 jsHandle.evaluateHandle 返回 JSHandle

如果传递给 jsHandle.evaluateHandle 的函数返回一个 Promise,则 jsHandle.evaluateHandle 将等待 Promise 解决并返回其值。

有关详细信息,请参阅 page.evaluateHandle()

用法

await jsHandle.evaluateHandle(pageFunction);
await jsHandle.evaluateHandle(pageFunction, arg);

参数

返回值


getProperties

在 v1.9 之前添加 jsHandle.getProperties

此方法返回一个映射,其中包含自有属性名称作为键,以及属性值的 JSHandle 实例。

用法

const handle = await page.evaluateHandle(() => ({ window, document }));
const properties = await handle.getProperties();
const windowHandle = properties.get('window');
const documentHandle = properties.get('document');
await handle.dispose();

返回值


getProperty

在 v1.9 之前添加 jsHandle.getProperty

从引用的对象中获取单个属性。

用法

await jsHandle.getProperty(propertyName);

参数

  • propertyName string#

    要获取的属性

返回值


jsonValue

在 v1.9 之前添加 jsHandle.jsonValue

返回对象的 JSON 表示。如果对象具有 toJSON 函数,则不会调用它

注意

如果引用的对象不可序列化,此方法将返回一个空 JSON 对象。如果对象具有循环引用,它将抛出错误。

用法

await jsHandle.jsonValue();

返回值