@data-client/test/lib/makeRenderDataClient/renderHook.d.cts

Testing utilities for Data Client

/**
 * Provides an abstraction over react 17 and 18 compatible libraries
 */
import type { Queries, waitForOptions } from '@testing-library/react';
import type { RenderHookOptions } from './renderHookOptions.js';
export declare const renderHook: RenderHook;
export default renderHook;
declare const UNDEFINED_VOID_ONLY: unique symbol;
type VoidOrUndefinedOnly = void | {
    [UNDEFINED_VOID_ONLY]: never;
};
interface ActType {
    (callback: () => VoidOrUndefinedOnly): void;
    <T>(callback: () => T | Promise<T>): Promise<T>;
}
export declare const act: ActType;
export type { RenderHookOptions };
type RenderHook = <Result, Props, Q extends Queries = Queries, Container extends Element | DocumentFragment = HTMLElement, BaseElement extends Element | DocumentFragment = Container>(render: (initialProps: Props) => Result, options?: RenderHookOptions<Props, Q, Container, BaseElement>) => RenderHookResult<Result, Props>;
export interface RenderHookResult<Result, Props> {
    /**
     * Triggers a re-render. The props will be passed to your renderHook callback.
     */
    rerender: (props?: Props) => void;
    /**
     * This is a stable reference to the latest value returned by your renderHook
     * callback
     */
    result: {
        /**
         * The value returned by your renderHook callback
         */
        current: Result;
        error?: Error;
    };
    /**
     * Unmounts the test component. This is useful for when you need to test
     * any cleanup your useEffects have.
     */
    unmount: () => void;
    waitForNextUpdate: (options?: waitForOptions) => Promise<void>;
    waitFor<T>(callback: () => Promise<T> | T, options?: waitForOptions): Promise<T>;
}
//# sourceMappingURL=renderHook.d.cts.map