Interface RenderHookResult<Result, Props>

interface RenderHookResult<Result, Props> {
    rerender: (props?: Props) => void;
    result: { current: Result };
    unmount: () => void;
}

Properties

rerender: (props?: Props) => void

Triggers a re-render. The props will be passed to your renderHook callback.

result: { current: Result }

This is a stable reference to the latest value returned by your renderHook callback

unmount: () => void

Unmounts the test component. This is useful for when you need to test any cleanup your useEffects have.