appium-mac2-driver/lib/commands/screenshots.ts

XCTest-based Appium driver for macOS apps automation

import type {Mac2Driver} from '../driver';
import type {ScreenshotsInfo} from '../types';

/**
 * Retrieves screenshots of each display available to macOS
 *
 * @param displayId - macOS display identifier to take a screenshot for.
 *                 If not provided then screenshots of all displays are going to be returned.
 *                 If no matches were found then an error is thrown.
 * @returns Screenshots information for the requested display(s)
 */
export async function macosScreenshots(
  this: Mac2Driver,
  displayId?: number,
): Promise<ScreenshotsInfo> {
  return (await this.wda.proxy.command('/wda/screenshots', 'POST', {displayId})) as ScreenshotsInfo;
}