fix: disable whenStable by default (#575)

Author: timdeschryver

projects/testing-library/src/tests/zoneless.spec.ts

@@ -85,9 +85,9 @@ test('renders and interacts with the component', async () => {
   expect(valueControl).toHaveTextContent('6');
 });
 
-test('renders and interacts with the component with skipWaitForStableOnRender set to true', async () => {
+test('renders and interacts with the component with skipDetectChanges set to true', async () => {
   const user = userEvent.setup();
-  await render(FixtureComponent, { skipWaitForStableOnRender: true });
+  await render(FixtureComponent, { skipDetectChanges: true });
 
   const incrementControl = screen.getByRole('button', { name: '+' });
   const decrementControl = screen.getByRole('button', { name: '-' });

projects/testing-library/zoneless/src/public_api.ts

@@ -75,6 +75,20 @@ export interface RenderOptions<Q extends Queries = typeof queries> {
    */
   configureTestBed?: (testbed: TestBed) => void;
 
+  /**
+   * @description
+   * Determines whether `fixture.detectChanges()` is called after the component is rendered.
+   *
+   * @default
+   * true
+   *
+   * @example
+   * await render(AppComponent, {
+   *  skipDetectChanges: false
+   * })
+   */
+  skipDetectChanges?: boolean;
+
   /**
    * @description
    * Determines whether `fixture.whenStable()` is called after the component is rendered.
@@ -84,10 +98,10 @@ export interface RenderOptions<Q extends Queries = typeof queries> {
    *
    * @example
    * await render(AppComponent, {
-   *  skipWaitForStableOnRender: false
+   *  waitForStableOnRender: false
    * })
    */
-  skipWaitForStableOnRender?: boolean;
+  waitForStableOnRender?: boolean;
 
   /**
    * @description
@@ -188,7 +202,11 @@ export async function render<ComponentType, WrapperType = ComponentType>(
       ? await createWrapperFixture(componentOrTemplate, (renderOptions ?? {}) as RenderTemplateOptions<WrapperType>)
       : await createComponentFixture(componentOrTemplate, (renderOptions ?? {}) as RenderComponentOptions);
 
-  if (renderOptions.skipWaitForStableOnRender !== true) {
+  if (renderOptions.skipDetectChanges !== true) {
+    fixture.detectChanges();
+  }
+
+  if (renderOptions.waitForStableOnRender === true) {
     await fixture.whenStable();
   }