Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(e2e): expose NuxtPage playwright type #1015

Merged
merged 2 commits into from
Dec 3, 2024

Conversation

sir-kain
Copy link
Contributor

❓ Type of change

  • πŸ“– Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

Export the NuxtPage interface for improved type safety in E2E tests

The NuxtPage interface provides extended typing for Playwright's Page object. However, this interface is not exported in the current implementation, making it inaccessible for users.

Example of usage:

import type { NuxtPage } from '@nuxt/test-utils'

const testPageFunction = async (page: NuxtPage) => {
  const heading = await page.getByRole('heading');
  expect(await heading.isVisible()).toBe(true);
};

@sir-kain sir-kain requested a review from danielroe as a code owner November 15, 2024 17:30
@danielroe danielroe changed the title Expose the NuxtPage interface for improved type safety in E2E tests feat(e2e): expose NuxtPage playwright type Dec 3, 2024
@danielroe danielroe merged commit be7d71c into nuxt:main Dec 3, 2024
4 checks passed
@github-actions github-actions bot mentioned this pull request Dec 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants