Skip to content

feat: add generic types support for render result queries #566

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.

Sign up for GitHub

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

Merged
timdeschryver merged 1 commit into from
Feb 13, 2026
Merged

feat: add generic types support for render result queries #566

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions projects/testing-library/src/lib/models.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import {
} from '@angular/core';
import { ComponentFixture, DeferBlockBehavior, DeferBlockState, TestBed } from '@angular/core/testing';
import { Routes } from '@angular/router';
import { BoundFunction, Queries, queries, Config as dtlConfig, PrettyDOMOptions } from '@testing-library/dom';
import { BoundFunctions, Queries, queries, Config as dtlConfig, PrettyDOMOptions } from '@testing-library/dom';

// TODO: import from Angular (is a breaking change)
interface OutputRef<T> {
Expand All @@ -29,7 +29,7 @@ export type OutputRefKeysWithCallback<T> = {
: never;
};

export type RenderResultQueries<Q extends Queries = typeof queries> = { [P in keyof Q]: BoundFunction<Q[P]> };
export type RenderResultQueries<Q extends Queries = typeof queries> = BoundFunctions<Q>;
export interface RenderResult<ComponentType, WrapperType = ComponentType> extends RenderResultQueries {
/**
* @description
Expand Down
23 changes: 23 additions & 0 deletions projects/testing-library/src/tests/render.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,29 @@ describe('DTL functionality', () => {
// eslint-disable-next-line testing-library/prefer-screen-queries
fireEvent.click(view.getByText('button'));
});

test('render result queries should support generic type parameter', async () => {
const view = await render(FixtureComponent);

// eslint-disable-next-line testing-library/prefer-screen-queries
const inputByTestId: HTMLInputElement = view.getByTestId<HTMLInputElement>('input');
expect(inputByTestId).toBeInTheDocument();

// screen.getByTestId should also accept a generic type parameter
const inputByScreen: HTMLInputElement = screen.getByTestId<HTMLInputElement>('input');
expect(inputByScreen).toBeInTheDocument();

// eslint-disable-next-line testing-library/prefer-screen-queries
const button: HTMLButtonElement = view.getByRole<HTMLButtonElement>('button');
expect(button).toBeInTheDocument();

// @ts-expect-error - generic narrows the type, so assigning HTMLInputElement to HTMLButtonElement should fail
// eslint-disable-next-line testing-library/prefer-screen-queries
const _wrongType: HTMLButtonElement = view.getByTestId<HTMLInputElement>('input');
void _wrongType;

expect(true).toBeTruthy();
});
});

describe('components', () => {
Expand Down