菜单
开源

screenshot([options])

获取元素的屏幕截图。

参数类型默认值描述
optionsobjectnull
options.pathstring''保存图像的文件路径。屏幕截图类型将从文件扩展名推断。如果 path 是相对路径,则它相对于当前工作目录解析。如果未提供路径,图像将不会保存到磁盘。
options.formatstringpng指定屏幕截图类型。可接受的值为 jpegpng
options.omitBackgroundbooleanfalse隐藏默认的白色背景,并允许捕获带透明度的屏幕截图。不适用于 jpeg 图像。
options.qualitynumber100图像质量,介于 0-100 之间;仅适用于 jpeg
options.timeoutnumber30000最大时间,单位为毫秒。传入 0 可禁用超时。默认值会被 BrowserContextPage 上的 setDefaultTimeout 选项覆盖。

返回值

类型描述
Promise<ArrayBuffer | null>包含捕获的屏幕截图的 ArrayBuffer

示例

JavaScript
import { browser } from 'k6/browser';

export const options = {
  scenarios: {
    browser: {
      executor: 'shared-iterations',
      options: {
        browser: {
          type: 'chromium',
        },
      },
    },
  },
};

export default async function () {
  const page = await browser.newPage();
  await page.goto('https://test.k6.io/browser.php');

  const element = await page.$(".header");
  const screenshot = await element.screenshot({
    path: 'header.png'
  });

  await page.close();
}