Skip to content

Commit

Permalink
docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
karmaniverous committed Dec 20, 2022
1 parent f27c9ff commit 9e4b728
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Use as the equalityFn argument to Redux useSelector() when the selected value is
```
**Example**
```js
// Deploy as an anonymousfunction to set options.const obj = useSelector((state) => state.slice.obj, (a, b) => blockRefresh(a, b, options));
// Deploy as an anonymous function to set options.const obj = useSelector( (state) => state.slice.obj, (a, b) => blockRefresh(a, b, options));
```
<a name="EqalityFn"></a>
Expand Down
2 changes: 1 addition & 1 deletion doc/3-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Use as the equalityFn argument to Redux useSelector() when the selected value is
```
**Example**
```js
// Deploy as an anonymousfunction to set options.const obj = useSelector((state) => state.slice.obj, (a, b) => blockRefresh(a, b, options));
// Deploy as an anonymous function to set options.const obj = useSelector( (state) => state.slice.obj, (a, b) => blockRefresh(a, b, options));
```
<a name="EqalityFn"></a>
Expand Down
7 changes: 5 additions & 2 deletions src/export/blockRefresh/blockRefresh.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,11 @@ import _ from 'lodash';
* const obj = useSelector((state) => state.slice.obj, blockRefresh);
*
* @example
* // Deploy as an anonymousfunction to set options.
* const obj = useSelector((state) => state.slice.obj, (a, b) => blockRefresh(a, b, options));
* // Deploy as an anonymous function to set options.
* const obj = useSelector(
* (state) => state.slice.obj,
* (a, b) => blockRefresh(a, b, options)
* );
*/
export const blockRefresh = (a, b, options = {}) => {
const { log, path, predicate, refreshUndefined } = options;
Expand Down

0 comments on commit 9e4b728

Please sign in to comment.