ReactLynx logoReactLynx logo
ReactLynx
Guide
APIs
Blog
Contribute
Guide
APIs
Blog
Contribute

reactlynx-testing-library / renderHook

Function: renderHook()

function renderHook<Result, Props>(render: (initialProps: Props) => Result, options?: RenderHookOptions<Props>): RenderHookResult<Result, Props>

Allows you to render a hook within a test React component without having to create that component yourself.

Type Parameters

Type Parameter
Result
Props

Parameters

ParameterType
render(initialProps: Props) => Result
options?RenderHookOptions<Props>

Returns

RenderHookResult<Result, Props>

Example

import { renderHook } from '@lynx-js/react/testing-library'

const Context = createContext('default');
function Wrapper({ children }) {
  return <Context.Provider value='provided'>{children}</Context.Provider>;
}
const { result } = renderHook(
  () => {
    return useContext(Context);
  },
  {
    wrapper: Wrapper,
  },
);

expect(result.current).toEqual('provided');

Defined in

index.d.ts:1266

Except as otherwise noted, this work is licensed under a Creative Commons Attribution 4.0 International License, and code samples are licensed under the Apache License 2.0.