extra-react-hooks 0.1.13 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (54) hide show
  1. package/README.md +21 -3
  2. package/dist/es2015/index.min.mjs +2 -2
  3. package/dist/es2015/index.min.mjs.map +1 -1
  4. package/dist/es2015/index.mjs +42 -7
  5. package/dist/es2015/index.mjs.map +1 -1
  6. package/dist/es2015/index.umd.js +44 -6
  7. package/dist/es2015/index.umd.js.map +1 -1
  8. package/dist/es2015/index.umd.min.js +2 -2
  9. package/dist/es2015/index.umd.min.js.map +1 -1
  10. package/dist/es2018/index.min.mjs +2 -2
  11. package/dist/es2018/index.min.mjs.map +1 -1
  12. package/dist/es2018/index.mjs +42 -7
  13. package/dist/es2018/index.mjs.map +1 -1
  14. package/dist/es2018/index.umd.js +44 -6
  15. package/dist/es2018/index.umd.js.map +1 -1
  16. package/dist/es2018/index.umd.min.js +2 -2
  17. package/dist/es2018/index.umd.min.js.map +1 -1
  18. package/lib/es2015/index.d.ts +3 -0
  19. package/lib/es2015/index.js +3 -0
  20. package/lib/es2015/index.js.map +1 -1
  21. package/lib/es2015/use-is-first-render.d.ts +1 -0
  22. package/lib/es2015/use-is-first-render.js +25 -0
  23. package/lib/es2015/use-is-first-render.js.map +1 -0
  24. package/lib/es2015/use-multiple-selection.d.ts +1 -1
  25. package/lib/es2015/use-multiple-selection.js +3 -3
  26. package/lib/es2015/use-multiple-selection.js.map +1 -1
  27. package/lib/es2015/use-render-counter.d.ts +1 -0
  28. package/lib/es2015/use-render-counter.js +11 -0
  29. package/lib/es2015/use-render-counter.js.map +1 -0
  30. package/lib/es2015/use-single-selection.d.ts +2 -2
  31. package/lib/es2015/use-single-selection.js +3 -3
  32. package/lib/es2015/use-single-selection.js.map +1 -1
  33. package/lib/es2015/use-update-effect.d.ts +2 -0
  34. package/lib/es2015/use-update-effect.js +15 -0
  35. package/lib/es2015/use-update-effect.js.map +1 -0
  36. package/lib/es2018/index.d.ts +3 -0
  37. package/lib/es2018/index.js +3 -0
  38. package/lib/es2018/index.js.map +1 -1
  39. package/lib/es2018/use-is-first-render.d.ts +1 -0
  40. package/lib/es2018/use-is-first-render.js +25 -0
  41. package/lib/es2018/use-is-first-render.js.map +1 -0
  42. package/lib/es2018/use-multiple-selection.d.ts +1 -1
  43. package/lib/es2018/use-multiple-selection.js +3 -3
  44. package/lib/es2018/use-multiple-selection.js.map +1 -1
  45. package/lib/es2018/use-render-counter.d.ts +1 -0
  46. package/lib/es2018/use-render-counter.js +11 -0
  47. package/lib/es2018/use-render-counter.js.map +1 -0
  48. package/lib/es2018/use-single-selection.d.ts +2 -2
  49. package/lib/es2018/use-single-selection.js +3 -3
  50. package/lib/es2018/use-single-selection.js.map +1 -1
  51. package/lib/es2018/use-update-effect.d.ts +2 -0
  52. package/lib/es2018/use-update-effect.js +15 -0
  53. package/lib/es2018/use-update-effect.js.map +1 -0
  54. package/package.json +1 -1
package/README.md CHANGED
@@ -26,11 +26,11 @@ function useSingleSelection<T>(
26
26
  values: T[]
27
27
  , defaultSelectedIndex: number
28
28
  ): {
29
- value: T
29
+ selectedValue: T
30
30
  options: Array<ISingleSelectionOption<T>>
31
31
  }
32
32
  function useSingleSelection<T>(values: T[]): {
33
- value: T | undefined
33
+ selectedValue: T | undefined
34
34
  options: Array<ISingleSelectionOption<T>>
35
35
  }
36
36
  ```
@@ -51,7 +51,7 @@ function useMultipleSelection<T>(
51
51
  values: T[]
52
52
  , defaultSelectedIndexes: number[] = []
53
53
  ): {
54
- values: T[]
54
+ selectedValues: T[]
55
55
  options: Array<IMultipleSelectionOption<T>>
56
56
  }
57
57
  ```
@@ -61,6 +61,14 @@ function useMultipleSelection<T>(
61
61
  function useMount(effect: EffectCallback): void
62
62
  ```
63
63
 
64
+ ### useUpdateEffect
65
+ ```ts
66
+ function useUpdateEffect(
67
+ effect: EffectCallback
68
+ , deps?: React.DependencyList
69
+ ): void
70
+ ```
71
+
64
72
  ### useStateCycle
65
73
  ```ts
66
74
  function useStateCycle<T>(
@@ -74,6 +82,11 @@ function useStateCycle<T>(
74
82
  function useIsMounted(): () => boolean
75
83
  ```
76
84
 
85
+ ### useIsFirstRender
86
+ ```ts
87
+ function useIsFirstRender(): () => boolean
88
+ ```
89
+
77
90
  ### useIncrement
78
91
  ```ts
79
92
  function useIncrement(
@@ -113,3 +126,8 @@ function useFiniteStateMachine<State extends string, Event extends string>(
113
126
  The `ObservableFiniteStateMachine` comes from [@blackglory/structures].
114
127
 
115
128
  [@blackglory/structures]: https://www.npmjs.com/package/@blackglory/structures
129
+
130
+ ### useRenderCounter
131
+ ```ts
132
+ function useRenderCounter(): number
133
+ ```