Updated README with testHook example

Author: mpeyper

README.md

@@ -64,28 +64,28 @@ const useTheme = (initialTheme) => {
 }
 
 // useTheme.test.js
-import { useHook, cleanup } from 'react-hooks-testing-library'
+import { testHook, cleanup, act } from 'react-hooks-testing-library'
 
 describe('custom hook tests', () => {
   afterEach(cleanup)
 
   test('should use theme', () => {
-    const { getCurrentValue } = useHook(() => useTheme('light'))
+    const { result } = testHook(() => useTheme('light'))
 
-    const theme = getCurrentValue()
+    const theme = result.current
 
     expect(theme.primaryLight).toBe('#FFFFFF')
     expect(theme.primaryDark).toBe('#000000')
   })
 
   test('should update theme', () => {
-    const { getCurrentValue, act } = useHook(() => useTheme('light'))
+    const { result } = testHook(() => useTheme('light'))
 
-    const { toggleTheme } = getCurrentValue()
+    const { toggleTheme } = result.current
 
     act(() => toggleTheme())
 
-    const theme = getCurrentValue()
+    const theme = result.current
 
     expect(theme.primaryLight).toBe('#000000')
     expect(theme.primaryDark).toBe('#FFFFFF')
@@ -97,11 +97,13 @@ describe('custom hook tests', () => {
       dark: { primaryLight: '#CCBBAA', primaryDark: '#AABBCC' }
     }
 
-    const { getCurrentValue, addContextProvider } = useHook(() => useTheme('light'))
+    const wrapper = ({ children }) => (
+      <ThemesContext.Provider value={customThemes}>{children}</ThemesContext.Provider>
+    )
 
-    addContextProvider(ThemesContext, { value: customThemes })
+    const { result } = testHook(() => useTheme('light'), { wrapper })
 
-    const theme = getCurrentValue()
+    const theme = result.current
 
     expect(theme.primaryLight).toBe('#AABBCC')
     expect(theme.primaryDark).toBe('#CCBBAA')

test/customHook.test.js

@@ -13,39 +13,37 @@ describe('custom hook tests', () => {
   const useTheme = (initialTheme) => {
     const themes = useContext(ThemesContext)
     const [theme, setTheme] = useState(initialTheme)
-    const changeTheme = () => {
+    const toggleTheme = () => {
       setTheme(theme === 'light' ? 'dark' : 'light')
     }
-    return useMemo(() => ({ ...themes[theme], changeTheme }), [theme])
+    return useMemo(() => ({ ...themes[theme], toggleTheme }), [theme])
   }
 
   afterEach(cleanup)
 
-  test('should get initial theme from custom hook', () => {
+  test('should use theme', () => {
     const { result } = testHook(() => useTheme('light'))
 
     const theme = result.current
 
     expect(theme.primaryLight).toBe('#FFFFFF')
     expect(theme.primaryDark).toBe('#000000')
-    expect(typeof theme.changeTheme).toBe('function')
   })
 
-  test('should update theme using custom hook', () => {
+  test('should update theme', () => {
     const { result } = testHook(() => useTheme('light'))
 
-    const { changeTheme } = result.current
+    const { toggleTheme } = result.current
 
-    act(() => changeTheme())
+    act(() => toggleTheme())
 
     const theme = result.current
 
     expect(theme.primaryLight).toBe('#000000')
     expect(theme.primaryDark).toBe('#FFFFFF')
-    expect(typeof theme.changeTheme).toBe('function')
   })
 
-  test('should get custom theme from custom hook', () => {
+  test('should use custom theme', () => {
     const customThemes = {
       light: { primaryLight: '#AABBCC', primaryDark: '#CCBBAA' },
       dark: { primaryLight: '#CCBBAA', primaryDark: '#AABBCC' }
@@ -61,6 +59,5 @@ describe('custom hook tests', () => {
 
     expect(theme.primaryLight).toBe('#AABBCC')
     expect(theme.primaryDark).toBe('#CCBBAA')
-    expect(typeof theme.changeTheme).toBe('function')
   })
 })