DocumentationTest AuthoringTypeScript API reference

TypeScript API reference

15 min readLast updated 2026-04-10

Complete reference for the Check Studio SDK, custom matchers, and fixture APIs.

The Check Studio SDK extends Playwright with custom fixtures, matchers, and utilities designed for test resilience and reporting.

Custom fixtures

import { test as base } from '@checkstudio/sdk';

export const test = base.extend({
  resilientPage: async ({ page }, use) => {
    await page.addInitScript(() => {
      // Inject resilience helpers
    });
    await use(page);
  },
});
typescript

Custom matchers

toHaveStableText()Retries until text is stable for 500ms
toBeAccessible()Runs WCAG 2.1 AA checks on the element
toHaveNoVisualRegression()Compares screenshot against baseline
toCompleteWithin(ms)Fails if action takes longer than threshold

Auto-complete

The SDK ships with TypeScript declarations. Import from @checkstudio/sdk for full IntelliSense in VS Code.

Was this article helpful?

Still have questions?

Our support team is here to help. Reach out directly or search the docs.