Function renderHook

src/render-hook.tsx:27–56

(
  hookToRender: (props: Props) => Result,
  options?: RenderHookOptions<NoInfer<Props>>,
)

};

export async function renderHook<Result, Props>(
  hookToRender: (props: Props) => Result,
  options?: RenderHookOptions<NoInfer<Props>>,
): Promise<RenderHookResult<Result, Props>> {
  const result = React.createRef<Result>() as RefObject<Result>;

  function HookContainer({ hookProps }: { hookProps: Props }) {
    const renderResult = hookToRender(hookProps);
    React.useEffect(() => {
      result.current = renderResult;
    });

    return null;
  }

  const { initialProps, wrapper, ...rest } = options ?? {};
  validateOptions('renderHook', rest, renderHook);
  const renderOptions = wrapper ? { wrapper } : {};
  const { rerender: rerenderComponent, unmount } = await render(
    // @ts-expect-error since option can be undefined, initialProps can be undefined when it shouldn't be
    <HookContainer hookProps={initialProps} />,
    renderOptions,
  );

  return {
    result: result,
    rerender: (hookProps: Props) => rerenderComponent(<HookContainer hookProps={hookProps} />),
    unmount,
  };
}