some minor hooks updates (#1294)

* fix wrong inline documentation for useSelectors hook

* add test to get test coverage for useSelector to 100%

* add test to verify that docs suggestion of putting a connected component above the hooks component allows dealing with stale props

src/hooks/useSelector.js

@@ -20,9 +20,9 @@ const refEquality = (a, b) => a === b
  * A hook to access the redux store's state. This hook takes a selector function
  * as an argument. The selector is called with the store state.
  *
- * This hook takes a dependencies array as an optional second argument,
- * which when passed ensures referential stability of the selector (this is primarily
- * useful if you provide a selector that memoizes values).
+ * This hook takes an optional equality comparison function as the second parameter
+ * that allows you to customize the way the selected state is compared to determine
+ * whether the component needs to be re-rendered.
  *
  * @param {Function} selector the selector function
  * @param {Function} equalityFn the function that will be used to determine equality
@@ -33,7 +33,6 @@ const refEquality = (a, b) => a === b
  *
  * import React from 'react'
  * import { useSelector } from 'react-redux'
- * import { RootState } from './store'
  *
  * export const CounterComponent = () => {
  *   const counter = useSelector(state => state.counter)

test/hooks/useSelector.spec.js

@@ -7,7 +7,8 @@ import * as rtl from 'react-testing-library'
 import {
   Provider as ProviderMock,
   useSelector,
-  shallowEqual
+  shallowEqual,
+  connect
 } from '../../src/index.js'
 import { useReduxContext } from '../../src/hooks/useReduxContext'
 
@@ -302,6 +303,78 @@ describe('React', () => {
 
           spy.mockRestore()
         })
+
+        it('re-throws errors from the selector that only occur during rendering', () => {
+          const spy = jest.spyOn(console, 'error').mockImplementation(() => {})
+
+          const Parent = () => {
+            const count = useSelector(s => s.count)
+            return <Child parentCount={count} />
+          }
+
+          const Child = ({ parentCount }) => {
+            const result = useSelector(({ count }) => {
+              if (parentCount > 0) {
+                throw new Error()
+              }
+
+              return count + parentCount
+            })
+
+            return <div>{result}</div>
+          }
+
+          rtl.render(
+            <ProviderMock store={store}>
+              <Parent />
+            </ProviderMock>
+          )
+
+          expect(() => store.dispatch({ type: '' })).toThrowError()
+
+          spy.mockRestore()
+        })
+
+        it('allows dealing with stale props by putting a specific connected component above the hooks component', () => {
+          const spy = jest.spyOn(console, 'error').mockImplementation(() => {})
+
+          const Parent = () => {
+            const count = useSelector(s => s.count)
+            return <ConnectedWrapper parentCount={count} />
+          }
+
+          const ConnectedWrapper = connect(({ count }) => ({ count }))(
+            ({ parentCount }) => {
+              return <Child parentCount={parentCount} />
+            }
+          )
+
+          let sawInconsistentState = false
+
+          const Child = ({ parentCount }) => {
+            const result = useSelector(({ count }) => {
+              if (count !== parentCount) {
+                sawInconsistentState = true
+              }
+
+              return count + parentCount
+            })
+
+            return <div>{result}</div>
+          }
+
+          rtl.render(
+            <ProviderMock store={store}>
+              <Parent />
+            </ProviderMock>
+          )
+
+          store.dispatch({ type: '' })
+
+          expect(sawInconsistentState).toBe(false)
+
+          spy.mockRestore()
+        })
       })
 
       describe('error handling for invalid arguments', () => {