Function takeScreenshot

packages/browser-playwright/src/commands/screenshot.ts:20–64

(
  context: BrowserCommandContext,
  name: string,
  options: Omit<ScreenshotCommandOptions, 'base64'>,
)

 * @throws {Error} If the function is not called within a test or if the browser provider does not support screenshots.
 */
export async function takeScreenshot(
  context: BrowserCommandContext,
  name: string,
  options: Omit<ScreenshotCommandOptions, 'base64'>,
): Promise<{ buffer: Buffer<ArrayBufferLike>; path: string }> {
  if (!context.testPath) {
    throw new Error(`Cannot take a screenshot without a test path`)
  }

  const path = resolveScreenshotPath(
    context.testPath,
    name,
    context.project.config,
    options.path,
  )

  // playwright does not need a screenshot path if we don't intend to save it
  let savePath: string | undefined

  if (options.save) {
    savePath = normalize(path)

    await mkdir(dirname(savePath), { recursive: true })
  }

  const mask = options.mask?.map(selector => getDescribedLocator(context, selector))

  if (options.element) {
    const { element: selector, ...config } = options
    const element = getDescribedLocator(context, selector)
    const buffer = await element.screenshot({
      ...config,
      mask,
      path: savePath,
    })
    return { buffer, path }
  }

  const buffer = await getDescribedLocator(context, 'body').screenshot({
    ...options,
    mask,
    path: savePath,
  })
  return { buffer, path }
}