@jelper/hooks 0.1.2 → 0.3.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 (65) hide show
  1. package/README.md +31 -31
  2. package/es/index.js +27 -1805
  3. package/es/useAsync.js +33 -0
  4. package/es/useBoolState.js +15 -0
  5. package/es/useCreate.js +5 -0
  6. package/es/useDebounce.js +12 -0
  7. package/es/useInterval.js +25 -0
  8. package/es/useIsUnmount.js +11 -0
  9. package/es/useListener.js +17 -0
  10. package/es/useMount.js +10 -0
  11. package/es/useParamsState.js +9 -0
  12. package/es/useResizeObserver.js +50 -0
  13. package/es/useRtCb.js +10 -0
  14. package/es/useRtEffect.js +7 -0
  15. package/es/useRtRef.js +7 -0
  16. package/es/useRtState.js +28 -0
  17. package/es/useSafeCb.js +11 -0
  18. package/es/useSafeState.js +8 -0
  19. package/es/useThrottle.js +19 -0
  20. package/es/useTimeout.js +34 -0
  21. package/es/useUnmount.js +11 -0
  22. package/es/useUpdateEffect.js +12 -0
  23. package/lib/index.js +52 -1798
  24. package/lib/useAsync.js +50 -0
  25. package/lib/useBoolState.js +20 -0
  26. package/lib/useCreate.js +7 -0
  27. package/lib/useDebounce.js +21 -0
  28. package/lib/useInterval.js +30 -0
  29. package/lib/useIsUnmount.js +13 -0
  30. package/lib/useListener.js +22 -0
  31. package/lib/useMount.js +15 -0
  32. package/lib/useParamsState.js +26 -0
  33. package/lib/useResizeObserver.js +56 -0
  34. package/lib/useRtCb.js +28 -0
  35. package/lib/useRtEffect.js +12 -0
  36. package/lib/useRtRef.js +10 -0
  37. package/lib/useRtState.js +34 -0
  38. package/lib/useSafeCb.js +20 -0
  39. package/lib/useSafeState.js +13 -0
  40. package/lib/useThrottle.js +28 -0
  41. package/lib/useTimeout.js +39 -0
  42. package/lib/useUnmount.js +13 -0
  43. package/lib/useUpdateEffect.js +15 -0
  44. package/package.json +7 -3
  45. package/types/index.d.ts +20 -0
  46. package/types/useAsync.d.ts +13 -0
  47. package/types/useBoolState.d.ts +2 -0
  48. package/types/useCreate.d.ts +2 -0
  49. package/types/useDebounce.d.ts +3 -0
  50. package/types/useInterval.d.ts +2 -0
  51. package/types/useIsUnmount.d.ts +2 -0
  52. package/types/useListener.d.ts +2 -0
  53. package/types/useMount.d.ts +2 -0
  54. package/types/useParamsState.d.ts +6 -0
  55. package/types/useResizeObserver.d.ts +1 -0
  56. package/types/useRtCb.d.ts +2 -0
  57. package/types/useRtEffect.d.ts +2 -0
  58. package/types/useRtRef.d.ts +2 -0
  59. package/types/useRtState.d.ts +6 -0
  60. package/types/useSafeCb.d.ts +2 -0
  61. package/types/useSafeState.d.ts +5 -0
  62. package/types/useThrottle.d.ts +10 -0
  63. package/types/useTimeout.d.ts +8 -0
  64. package/types/useUnmount.d.ts +2 -0
  65. package/types/useUpdateEffect.d.ts +1 -0
@@ -0,0 +1,10 @@
1
+ import { ThrottleSettings } from 'lodash-es';
2
+ /**
3
+ * 用于节流函数的钩子函数
4
+ * @param cb - 要节流的函数
5
+ * @param wait - 节流延迟时间,默认为0
6
+ * @param opts - 节流选项对象,默认为{}
7
+ * @returns 节流函数
8
+ */
9
+ declare const useThrottle: <T extends (...args: any) => any>(cb: T, wait?: number, opts?: ThrottleSettings) => import("lodash-es").DebouncedFunc<(...arg: Parameters<T>) => void>;
10
+ export default useThrottle;
@@ -0,0 +1,8 @@
1
+ /**
2
+ * 使用定时器在指定延迟后执行回调函数
3
+ * @param callback - 回调函数
4
+ * @param delay - 延迟时间(毫秒)
5
+ * @returns clearTimer - 清除定时器的函数
6
+ */
7
+ declare const useTimeout: (callback: DefFn, delay: number) => () => void;
8
+ export default useTimeout;
@@ -0,0 +1,2 @@
1
+ declare const useUnmount: (cb: Function) => void;
2
+ export default useUnmount;
@@ -0,0 +1 @@
1
+ export default function useUpdateEffect(cb: () => void, deps: any[]): void;