Type Support for Amazon CloudWatch Synthetics Node.js Playwright Runtime

TypeScript type definitions for Amazon CloudWatch Synthetics syn-nodejs-playwright-* runtime.

Installation

Please ensure the type definition package version matches your canary's runtime version.

npm install @aws/synthetics-playwright

Usage

import { synthetics } from '@aws/synthetics-playwright';
import { Browser, Page } from 'playwright';

const runCanary = async () => {
    // Launch browser with default Synthetics options
    const browser: Browser = await synthetics.launch();
    
    // Create a new page with HAR recording
    const page: Page = await synthetics.newPage(browser);
    
    // Execute monitored steps
    await synthetics.executeStep('navigate', async () => {
        await page.goto('https://example.com');
    });
    
    await synthetics.executeStep('verify-content', async () => {
        await page.waitForSelector('h1');
    }, {
        screenshotOnStepFailure: true,
        continueOnStepFailure: false
    }, page);
    
    // Clean up
    await synthetics.close();
};

TypeScript Support

This package provides complete TypeScript type definitions for the Amazon CloudWatch Synthetics Node.js Playwright runtime, enabling full IntelliSense support and type checking in your canary scripts.

Security

See CONTRIBUTING for more information.

License

This project is licensed under the Apache-2.0 License.