README

react-proxy-hook

Helps you test a React Hook

Requirement ⚠️

To use react-proxy-hook, you must use react@16.8.0-alpha.1. React Hooks is currently at RFC stage.

Installation

$ npm i -D react-proxy-hook

Usage

react-proxy-hook is a wrapper around Kent C. Dodd's react-testing-library. It was inspired by the setup function that Kent wrote in his YouTube video. It is presented here as a simple React Hooks function wrapper.

Hooks can not be tested as standalone functions as they will not work unless they are called from withing a rendered component. react-proxy-hook gets around this limitation by proxying an actual component.

Maybe should have been called a HOH (Higher Order Hook)?

Look at how easy testing a Hook can be!

Method 1: `testHook`

Method 1 requires that you place the call to your cutom Hook inside of a callback function. You then destructure (or not) your data into a let that you previously defined.

import { testHook, cleanup } from 'react-proxy-hook';
import useCounter from '../use-counter';

afterEach(cleanup);

test('useCounter', () => {
  let count, increment;
  testHook(() => ({ count, increment } = useCounter({ initialCount: 2 })));

  expect(count).toBe(2);
  increment();
  expect(count).toBe(3);
});

Using Method 1 (suggested), there are no restrictions on destructuring.

I've made a PR into react-testing-library for this, so hopefully this will be in merged soon.

See the test for Method 1 running live on CodeSandbox.

Method 2: `proxyHook`

You test your Hook just like you would use it in an actual component. Just pass your actual hook to proxyHook and it will return a proxied version of your hook.

import { proxyHook, cleanup } from 'react-proxy-hook';
import useCounter from '../use-counter';

const useCounterProxy = proxyHook(useCounter);

afterEach(cleanup);

test('useCounter', () => {
  const counterData = useCounterProxy();
  counterData.increment();
  expect(counterData.count).toBe(1);
  counterData.decrement();
  expect(counterData.count).toBe(0);
});

See the test for Method 2 running live on CodeSandbox.

Testing objects

To test with a returned object (ex: { foo: 'bar' } ) use the dot notation.

const returnedVal = useFooProxy();
expect(returnedVal.foo).toBe('bar');

Testing arrays

To test with a returned array (ex: [0] ) use bracket notation.

const returnedVal = useFooProxy();
expect(returnedVal[0]).toBe(0);

Testing other types

To test with other returned types (i.e. string, numbers, null, undefined), use they key "value".

const returnedVal = useFooProxy();
expect(returnedVal.value).toBe('foo');

Limitations

You must not deconstruct the returned value in your test. For example, the following wo't work as count will still be 0.

const { count, increment } = useCounterProxy(0);
increment();
expect(count).toBe(1);

License

MIT Licensed

Obviously, none of this would not be possible without the tireless work of Kent C. Dodds. Thank you! 🙏

Usage no npm install needed!