screenshot([options])

返回从浏览器捕获的屏幕截图缓冲区。

参数	类型	默认值	描述
options	对象	`null`
options.clip	对象	`null`	一个指定结果图像裁剪区域的对象。
options.clip.x	数字	`0`	裁剪区域左上角的 x 坐标。
options.clip.y	数字	`0`	裁剪区域左上角的 y 坐标。
options.clip.width	数字	`0`	裁剪区域的宽度。
options.clip.height	数字	`0`	裁剪区域的高度。
options.fullPage	布尔值	`false`	如果为 true，则截取整个可滚动页面的屏幕截图，而不是当前可见的视口。
options.omitBackground	布尔值	`false`	隐藏默认白色背景，允许捕获带有透明度的屏幕截图。不适用于 `jpeg` 图像。
options.path	字符串	`''`	保存图像的文件路径。屏幕截图类型将从文件扩展名推断。如果 `path` 是相对路径，则相对于当前工作目录解析。如果未提供路径，图像将不会保存到磁盘。
options.quality	数字	`0`	图像质量，介于 0-100 之间；仅适用于 `jpeg` 格式。
options.type	字符串	`png`	指定屏幕截图类型。可接受的值为 `jpeg` 和 `png`。

返回值

类型	描述
`Promise<Buffer>`	一个 Promise，其值是一个 Buffer，包含捕获的屏幕截图。

示例

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');
  await page.screenshot({ path: 'screenshots/browser.png' });
}