Skip to content

Commit

Permalink
Bump version and update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jleider committed Nov 23, 2021
1 parent 8695347 commit c2e869a
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 9 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,14 +61,15 @@ useStableEffect(() => {

## API

| React Hook | Stable Hook | Description |
|-------------|-------------------|-------------|
| useState | useStable | Base hook that requires an equality function |
| | useStableE | Helper function which automatically proves the top level equality function for `Either` |
| | useStableO | Helper function which automatically proves the top level equality function for `Option` |
| useEffect | useStableEffect | Base hook that requires an equality function |
| useCallback | useStableCallback | Base hook that requires an equality function |
| useMemo | useStableMemo | Base hook that requires an equality function |
| React Hook | Stable Hook | Description |
|-----------------|-----------------------|-------------|
| useState | useStable | Base hook that requires an equality function |
| | useStableE | Helper function which automatically proves the top level equality function for `Either` |
| | useStableO | Helper function which automatically proves the top level equality function for `Option` |
| useEffect | useStableEffect | Base hook that requires an equality function |
| useLayoutEffect | useStableLayoutEffect | Base hook that requires an equality function |
| useCallback | useStableCallback | Base hook that requires an equality function |
| useMemo | useStableMemo | Base hook that requires an equality function |

## React Hooks Linter
If you already use the recommended react hooks lint rule you can add this to your `eslint` file.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "fp-ts-react-stable-hooks",
"version": "1.2.1",
"version": "1.3.1",
"description": "Stable hooks for react using FP-TS equality checks instead of shallow (reference) object comparison",
"main": "dist/lib/index.js",
"module": "dist/es2015/index.js",
Expand Down

0 comments on commit c2e869a

Please sign in to comment.