跳转到主要内容

JSHandle

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

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

JSHandle 会阻止所引用的 JavaScript 对象被垃圾回收,除非调用 jsHandle.dispose() 释放该句柄。当 JSHandle 的来源框架(origin frame)导航至新页面或父级上下文被销毁时,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();

返回