@testing-library/react - npm Package Compare versions

Comparing version 15.0.3 to 15.0.4

package.json

 {
   "name": "@testing-library/react",
-  "version": "15.0.3",
+  "version": "15.0.4",
   "description": "Simple and complete React DOM testing utilities that encourage good testing practices.",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

types/index.d.ts

@@ -182,8 +182,8 @@ // TypeScript Version: 3.8
 
-export interface RenderHookOptions<
+export interface BaseRenderHookOptions<
   Props,
-  Q extends Queries = typeof queries,
-  Container extends Element | DocumentFragment = HTMLElement,
-  BaseElement extends Element | DocumentFragment = Container,
-> extends RenderOptions<Q, Container, BaseElement> {
+  Q extends Queries,
+  Container extends RendererableContainer | HydrateableContainer,
+  BaseElement extends Element | DocumentFragment,
+> extends BaseRenderOptions<Q, Container, BaseElement> {
   /**
@@ -196,2 +196,41 @@ * The argument passed to the renderHook callback. Can be useful if you plan
 
+export interface ClientRenderHookOptions<
+  Props,
+  Q extends Queries,
+  Container extends Element | DocumentFragment,
+  BaseElement extends Element | DocumentFragment = Container,
+> extends BaseRenderHookOptions<Props, Q, Container, BaseElement> {
+  /**
+   * If `hydrate` is set to `true`, then it will render with `ReactDOM.hydrate`. This may be useful if you are using server-side
+   *  rendering and use ReactDOM.hydrate to mount your components.
+   *
+   *  @see https://testing-library.com/docs/react-testing-library/api/#hydrate)
+   */
+  hydrate?: false | undefined
+}
+
+export interface HydrateHookOptions<
+  Props,
+  Q extends Queries,
+  Container extends Element | DocumentFragment,
+  BaseElement extends Element | DocumentFragment = Container,
+> extends BaseRenderHookOptions<Props, Q, Container, BaseElement> {
+  /**
+   * If `hydrate` is set to `true`, then it will render with `ReactDOM.hydrate`. This may be useful if you are using server-side
+   *  rendering and use ReactDOM.hydrate to mount your components.
+   *
+   *  @see https://testing-library.com/docs/react-testing-library/api/#hydrate)
+   */
+  hydrate: true
+}
+
+export type RenderHookOptions<
+  Props,
+  Q extends Queries = typeof queries,
+  Container extends Element | DocumentFragment = HTMLElement,
+  BaseElement extends Element | DocumentFragment = Container,
+> =
+  | ClientRenderHookOptions<Props, Q, Container, BaseElement>
+  | HydrateHookOptions<Props, Q, Container, BaseElement>
+
 /**
@@ -205,8 +244,18 @@ * Allows you to render a hook within a test React component without having to
   Q extends Queries = typeof queries,
-  Container extends Element | DocumentFragment = HTMLElement,
+  Container extends RendererableContainer = HTMLElement,
   BaseElement extends Element | DocumentFragment = Container,
 >(
   render: (initialProps: Props) => Result,
-  options?: RenderHookOptions<Props, Q, Container, BaseElement>,
+  options?: ClientRenderHookOptions<Props, Q, Container, BaseElement>,
 ): RenderHookResult<Result, Props>
+export function renderHook<
+  Result,
+  Props,
+  Q extends Queries = typeof queries,
+  Container extends HydrateableContainer = HTMLElement,
+  BaseElement extends Element | DocumentFragment = Container,
+>(
+  render: (initialProps: Props) => Result,
+  options?: HydrateHookOptions<Props, Q, Container, BaseElement>,
+): RenderHookResult<Result, Props>
 
@@ -213,0 +262,0 @@ /**

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

4303366

increased by0.04%

Lines of code

29244

increased by0.16%

No dependency changes