wait-for-hook-change v1.0.5

Getting started

This package allows you to await a change in a hook's output from the result of testing-library's renderHook function.

To add to your package simply run the following:

NPM:

npm i -D wait-for-hook-change

Yarn:

yarn add --dev wait-for-hook-change

Note: This library relies on @testing-library/react and is not included. You must have this installed in your package.

Usage

waitForHookChange allows you to pass in a callback which will trigger a state change along with the hook result (from renderHook) and will return a promise which will resolve once the result's .current property changes.

The callback will be wrapped in act to allow for state changes to be used.

Example hook:

const useAdder = () => {
  const [value, setValue] = useState(0)

  return {
    value,
    addOne: () => setValue(value + 1),
  }
}

Testing the result of a hook change:

import { waitForHookChange } from 'wait-for-hook-change'

it('should return 1 after calling addOne', async () => {
  const { result } = renderHook(useAdder)

  await waitForHookChange(result, () => result.current?.addOne())

  expect(result.current.value).toBe(1)
})