extra-react-hooks 0.8.6 → 0.8.8

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.
package/README.md CHANGED
@@ -71,7 +71,7 @@ function useEffectAsync(
71
71
  ```ts
72
72
  function useAbortableCallback<Args extends unknown[], Result>(
73
73
  callback: (...args: [...args: Args, signal: AbortSignal]) => PromiseLike<Result>
74
- , deps: React.DependencyList
74
+ , deps?: React.DependencyList
75
75
  ): (...args: [...args: Args, signal: AbortSignal | Falsy]) => Promise<Result>
76
76
  ```
77
77
 
@@ -83,6 +83,14 @@ function useUpdateEffect(
83
83
  ): void
84
84
  ```
85
85
 
86
+ ### useUpdateLayoutEffect
87
+ ```ts
88
+ function useUpdateLayoutEffect(
89
+ effect: EffectCallback
90
+ , deps?: React.DependencyList
91
+ ): void
92
+ ```
93
+
86
94
  ### useStateCycle
87
95
  ```ts
88
96
  function useStateCycle<T>(
package/lib/index.d.ts CHANGED
@@ -8,6 +8,7 @@ export * from './use-unmount.js';
8
8
  export * from './use-effect-async.js';
9
9
  export * from './use-abortable-callback.js';
10
10
  export * from './use-update-effect.js';
11
+ export * from './use-update-layout-effect.js';
11
12
  export * from './use-single-selection.js';
12
13
  export * from './use-multiple-selection.js';
13
14
  export * from './use-state-cycle.js';
package/lib/index.js CHANGED
@@ -8,6 +8,7 @@ export * from './use-unmount.js';
8
8
  export * from './use-effect-async.js';
9
9
  export * from './use-abortable-callback.js';
10
10
  export * from './use-update-effect.js';
11
+ export * from './use-update-layout-effect.js';
11
12
  export * from './use-single-selection.js';
12
13
  export * from './use-multiple-selection.js';
13
14
  export * from './use-state-cycle.js';
package/lib/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAA;AAClC,cAAc,qBAAqB,CAAA;AACnC,cAAc,0BAA0B,CAAA;AACxC,cAAc,yBAAyB,CAAA;AACvC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,sBAAsB,CAAA;AACpC,cAAc,kBAAkB,CAAA;AAChC,cAAc,uBAAuB,CAAA;AACrC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,wBAAwB,CAAA;AACtC,cAAc,2BAA2B,CAAA;AACzC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,sBAAsB,CAAA;AACpC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,0BAA0B,CAAA;AACxC,cAAc,gCAAgC,CAAA;AAC9C,cAAc,eAAe,CAAA;AAC7B,cAAc,uBAAuB,CAAA;AACrC,cAAc,+BAA+B,CAAA;AAC7C,cAAc,eAAe,CAAA;AAC7B,cAAc,qBAAqB,CAAA;AACnC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,kBAAkB,CAAA;AAChC,cAAc,mCAAmC,CAAA;AACjD,cAAc,mBAAmB,CAAA;AACjC,cAAc,uBAAuB,CAAA;AACrC,cAAc,sBAAsB,CAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAA;AAClC,cAAc,qBAAqB,CAAA;AACnC,cAAc,0BAA0B,CAAA;AACxC,cAAc,yBAAyB,CAAA;AACvC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,sBAAsB,CAAA;AACpC,cAAc,kBAAkB,CAAA;AAChC,cAAc,uBAAuB,CAAA;AACrC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,wBAAwB,CAAA;AACtC,cAAc,+BAA+B,CAAA;AAC7C,cAAc,2BAA2B,CAAA;AACzC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,sBAAsB,CAAA;AACpC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,0BAA0B,CAAA;AACxC,cAAc,gCAAgC,CAAA;AAC9C,cAAc,eAAe,CAAA;AAC7B,cAAc,uBAAuB,CAAA;AACrC,cAAc,+BAA+B,CAAA;AAC7C,cAAc,eAAe,CAAA;AAC7B,cAAc,qBAAqB,CAAA;AACnC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,kBAAkB,CAAA;AAChC,cAAc,mCAAmC,CAAA;AACjD,cAAc,mBAAmB,CAAA;AACjC,cAAc,uBAAuB,CAAA;AACrC,cAAc,sBAAsB,CAAA"}
@@ -1,2 +1,2 @@
1
1
  import { Falsy } from '@blackglory/prelude';
2
- export declare function useAbortableCallback<Args extends unknown[], Result>(callback: (...args: [...args: Args, signal: AbortSignal]) => PromiseLike<Result>, deps: React.DependencyList): (...args: [...args: Args, signal: AbortSignal | Falsy]) => Promise<Result>;
2
+ export declare function useAbortableCallback<Args extends unknown[], Result>(callback: (...args: [...args: Args, signal: AbortSignal]) => PromiseLike<Result>, deps?: React.DependencyList): (...args: [...args: Args, signal: AbortSignal | Falsy]) => Promise<Result>;
@@ -11,6 +11,6 @@ export function useAbortableCallback(callback, deps) {
11
11
  signal.throwIfAborted();
12
12
  const realArgs = args.slice(0, -1);
13
13
  return await callback(...realArgs, signal);
14
- }, [controller, ...deps]);
14
+ }, [controller]);
15
15
  }
16
16
  //# sourceMappingURL=use-abortable-callback.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"use-abortable-callback.js","sourceRoot":"","sources":["../src/use-abortable-callback.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,OAAO,CAAA;AACnC,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAG/D,MAAM,UAAU,oBAAoB,CAClC,QAAgF,EAChF,IAA0B;IAE1B,MAAM,UAAU,GAAG,kBAAkB,CACnC,GAAG,EAAE,CAAC,IAAI,eAAe,EAAE,EAC3B,UAAU,CAAC,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,EAChC,IAAI,CACL,CAAA;IAED,OAAO,WAAW,CAAC,KAAK,EAAE,GAAG,IAAkD,EAAE,EAAE;QACjF,MAAM,MAAM,GAAG,gBAAgB,CAAC;YAC9B,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAwB;YAC5C,UAAU,CAAC,MAAM;SAClB,CAAC,CAAA;QACF,MAAM,CAAC,cAAc,EAAE,CAAA;QAEvB,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAS,CAAA;QAE1C,OAAO,MAAM,QAAQ,CAAC,GAAG,QAAQ,EAAE,MAAM,CAAC,CAAA;IAC5C,CAAC,EAAE,CAAC,UAAU,EAAE,GAAG,IAAI,CAAC,CAAC,CAAA;AAC3B,CAAC"}
1
+ {"version":3,"file":"use-abortable-callback.js","sourceRoot":"","sources":["../src/use-abortable-callback.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,OAAO,CAAA;AACnC,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAG/D,MAAM,UAAU,oBAAoB,CAClC,QAAgF,EAChF,IAA2B;IAE3B,MAAM,UAAU,GAAG,kBAAkB,CACnC,GAAG,EAAE,CAAC,IAAI,eAAe,EAAE,EAC3B,UAAU,CAAC,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,EAChC,IAAI,CACL,CAAA;IAED,OAAO,WAAW,CAAC,KAAK,EAAE,GAAG,IAAkD,EAAE,EAAE;QACjF,MAAM,MAAM,GAAG,gBAAgB,CAAC;YAC9B,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAwB;YAC5C,UAAU,CAAC,MAAM;SAClB,CAAC,CAAA;QACF,MAAM,CAAC,cAAc,EAAE,CAAA;QAEvB,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAS,CAAA;QAE1C,OAAO,MAAM,QAAQ,CAAC,GAAG,QAAQ,EAAE,MAAM,CAAC,CAAA;IAC5C,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAA;AAClB,CAAC"}
@@ -0,0 +1,2 @@
1
+ import { EffectCallback } from 'react';
2
+ export declare function useUpdateLayoutEffect(effect: EffectCallback, deps?: React.DependencyList): void;
@@ -0,0 +1,11 @@
1
+ import { useIsFirstRender } from './use-is-first-render.js';
2
+ import { useIsomorphicLayoutEffect } from './use-isomorphic-layout-effect.js';
3
+ export function useUpdateLayoutEffect(effect, deps) {
4
+ const isFirstRender = useIsFirstRender();
5
+ useIsomorphicLayoutEffect(() => {
6
+ if (!isFirstRender()) {
7
+ return effect();
8
+ }
9
+ }, deps);
10
+ }
11
+ //# sourceMappingURL=use-update-layout-effect.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-update-layout-effect.js","sourceRoot":"","sources":["../src/use-update-layout-effect.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAC3D,OAAO,EAAE,yBAAyB,EAAE,MAAM,mCAAmC,CAAA;AAE7E,MAAM,UAAU,qBAAqB,CACnC,MAAsB,EACtB,IAA2B;IAE3B,MAAM,aAAa,GAAG,gBAAgB,EAAE,CAAA;IAExC,yBAAyB,CAAC,GAAG,EAAE;QAC7B,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC;YACrB,OAAO,MAAM,EAAE,CAAA;QACjB,CAAC;IACH,CAAC,EAAE,IAAI,CAAC,CAAA;AACV,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "extra-react-hooks",
3
- "version": "0.8.6",
3
+ "version": "0.8.8",
4
4
  "description": "",
5
5
  "keywords": [],
6
6
  "files": [
package/src/index.ts CHANGED
@@ -8,6 +8,7 @@ export * from './use-unmount.js'
8
8
  export * from './use-effect-async.js'
9
9
  export * from './use-abortable-callback.js'
10
10
  export * from './use-update-effect.js'
11
+ export * from './use-update-layout-effect.js'
11
12
  export * from './use-single-selection.js'
12
13
  export * from './use-multiple-selection.js'
13
14
  export * from './use-state-cycle.js'
@@ -5,7 +5,7 @@ import { Falsy } from '@blackglory/prelude'
5
5
 
6
6
  export function useAbortableCallback<Args extends unknown[], Result>(
7
7
  callback: (...args: [...args: Args, signal: AbortSignal]) => PromiseLike<Result>
8
- , deps: React.DependencyList
8
+ , deps?: React.DependencyList
9
9
  ): (...args: [...args: Args, signal: AbortSignal | Falsy]) => Promise<Result> {
10
10
  const controller = useMemoWithCleanup(
11
11
  () => new AbortController()
@@ -23,5 +23,5 @@ export function useAbortableCallback<Args extends unknown[], Result>(
23
23
  const realArgs = args.slice(0, -1) as Args
24
24
 
25
25
  return await callback(...realArgs, signal)
26
- }, [controller, ...deps])
26
+ }, [controller])
27
27
  }
@@ -0,0 +1,16 @@
1
+ import { EffectCallback } from 'react'
2
+ import { useIsFirstRender } from './use-is-first-render.js'
3
+ import { useIsomorphicLayoutEffect } from './use-isomorphic-layout-effect.js'
4
+
5
+ export function useUpdateLayoutEffect(
6
+ effect: EffectCallback
7
+ , deps?: React.DependencyList
8
+ ): void {
9
+ const isFirstRender = useIsFirstRender()
10
+
11
+ useIsomorphicLayoutEffect(() => {
12
+ if (!isFirstRender()) {
13
+ return effect()
14
+ }
15
+ }, deps)
16
+ }